Mac Dev Center Mac OS X Reference Library Drivers, Kernel, & Hardware: User-Space Device Access Disc Recording UI Framework Reference

Overview

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

Discussion

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.

Methods

-beginProgressPanelForBurn:layout:

Presents the progress panel on screen and begins the burn process.

-beginProgressSheetForBurn:layout:modalForWindow:

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

-description

Returns the description string displayed in the panel.

+progressPanel

Creates and returns an instance of the burn progress panel.

-setDescription:

Sets the panel text displayed to the user.

-setVerboseProgressStatus:

Sets the vebosity of the progress feedback.

-stopBurn:

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

-verboseProgressStatus

Returns the vebosity of the panel.

Presents the progress panel on screen and begins the burn process.

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

Parameters

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.

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

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

Parameters

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.

Returns the description string displayed in the panel.

- (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.

Creates and returns an instance of the burn progress panel.

+ (DRBurnProgressPanel*) progressPanel; 

Return Value

A pointer to the newly created DRBurnProgressPanel.

Sets the panel text displayed to the user.

- (void) setDescription:(NSString*)description; 

Parameters

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.

Sets the vebosity of the progress feedback.

- (void) setVerboseProgressStatus:(BOOL)verbose; 

Parameters

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.

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

- (IBAction) stopBurn:(id)sender; 

Returns the vebosity of the panel.

- (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.