Mac Developer Library

Developer

DREraseProgressPanel Class Reference

Options
Deployment Target:

On This Page

DREraseProgressPanel

Manages a panel that displays progress while erasing media.

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

The erase is begun and a progress panel is displayed on screen by calling beginProgressSheetForErase:modalForWindow: if a sheet interface is desired, or beginProgressPanelForErase: for a non-modal panel.

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

  • Presents the progress panel on screen and begins the erase process.

    Declaration

    - (void) beginProgressPanelForErase:(DRErase*)erase;

    Parameters

    erase

    The object performing the erase.

    Discussion

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

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

    Declaration

    - (void) beginProgressSheetForErase:(DRErase*)erase modalForWindow:(NSWindow *)docWindow;

    Parameters

    erase

    The object performing the erase.

    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 erase. Once the method has returned the caller can perform other operations while the erase continues.

  • Returns the description string displayed in the panel.

    Declaration

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

  • Sets the panel text displayed to the user.

    Declaration

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

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

    Declaration

    + (DREraseProgressPanel*) progressPanel;

    Return Value

    A pointer to the newly created DREraseProgressPanel.