Mac Developer Library

Developer

DRBurnProgressPanel Class Reference

Options
Deployment Target:

On This Page
Language:

DRBurnProgressPanel

Manages a panel that displays progress while burning data to media.

A DRBurnProgressPanel object manages a panel that displays and updates burn progress. The burn panel is responsible for begining the burn.

The burn is begun and a progress panel is displayed on screen by calling beginProgressSheetForBurn:layout:modalForWindow: if a sheet interface is desired, or beginProgressPanelForBurn:layout: for a non-modal panel.

A DRBurnProgressPanel sends a burnProgressPanel:burnDidFinish: message to it's delegate when the burn completes. This method allows the delegate to take over end-of-burn handling from the burn progress panel to customize error dialogs or user notification.

Inheritance


Import Statement


Swift

import DiscRecordingUI

Objective-C

@import DiscRecordingUI;

Availability


Available in OS X v10.2 and later.
  • Presents the progress panel on screen and begins the burn process.

    Declaration

    Swift

    func beginProgressPanelForBurn(_ burn: DRBurn!, layout layout: AnyObject!)

    Objective-C

    - (void)beginProgressPanelForBurn:(DRBurn *)burn layout:(id)layout

    Parameters

    burn

    The object performing the burn.

    layout

    The data to be burned to disc. See the DRBurn documentation for information on valid layouts.

    Discussion

    This method returns control to the caller after it has displayed the progress sheet and begun the burn. Once the method has returned the caller can perform other operations while the burn continues.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Presents the progress panel as a sheet and begins the burn process.

    Declaration

    Swift

    func beginProgressSheetForBurn(_ burn: DRBurn!, layout layout: AnyObject!, modalForWindow docWindow: NSWindow!)

    Objective-C

    - (void)beginProgressSheetForBurn:(DRBurn *)burn layout:(id)layout modalForWindow:(NSWindow *)docWindow

    Parameters

    burn

    The object performing the burn.

    layout

    The data to be burned to disc. See the DRBurn documentation for information on valid layouts.

    docWindow

    The window the sheet will be attached to. If docWindow is not nil, the panel slides down as a sheet running as a document modal window. If owner is nil, this is an error.

    Discussion

    This method returns control to the caller after it has displayed the progress sheet and begun the burn. Once the method has returned the caller can perform other operations while the burn continues.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the description string displayed in the panel.

    Declaration

    Swift

    func description() -> String!

    Objective-C

    - (NSString *)description

    Return Value

    An NSString containing the text of the description.

    Discussion

    If no description is explicitly set, this method will return the standard text string.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the panel text displayed to the user.

    Declaration

    Swift

    func setDescription(_ description: String!)

    Objective-C

    - (void)setDescription:(NSString *)description

    Parameters

    description

    The text to display.

    Discussion

    The panel's description is typically a short text string that gives an indication to the user what operation is being performed. If no description is explicitly set, the progress panel uses a standard text string suitable to the burn.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Sets the vebosity of the progress feedback.

    Declaration

    Swift

    func setVerboseProgressStatus(_ verbose: Bool)

    Objective-C

    - (void)setVerboseProgressStatus:(BOOL)verbose

    Parameters

    verbose

    A BOOL value indicating how detailed the status panel feedback should be.

    Discussion

    If verbose is YES, the panel will update status for every change. If verbose is NO, the panel will filter some status messages and only update for major changes. The default for the panel is filter the status messages.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Invoked when the user clicks the panel's stop button.

    Declaration

    Swift

    @IBAction func stopBurn(_ sender: AnyObject!)

    Objective-C

    - (IBAction)stopBurn:(id)sender

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Returns the vebosity of the panel.

    Declaration

    Swift

    func verboseProgressStatus() -> Bool

    Objective-C

    - (BOOL)verboseProgressStatus

    Return Value

    A BOOL value indicating how detailed the status panel feedback is.

    Discussion

    This method will return YES if the panel will update status for every change and NO if the panel will filter some status messages and only update for major changes.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Swift

    import DiscRecordingUI

    Availability

    Available in OS X v10.2 and later.

  • Creates and returns an instance of the burn progress panel.

    Declaration

    Objective-C

    + (DRBurnProgressPanel *)progressPanel

    Return Value

    A pointer to the newly created DRBurnProgressPanel.

    Import Statement

    Objective-C

    @import DiscRecordingUI;

    Availability

    Available in OS X v10.2 and later.