Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_AskSaveChangesDialog Class Reference

Presents the platforms AskSaveChangesDialog.

Inheritance diagram for CP_AskSaveChangesDialog:

CP_FileSystemDialogs_Base List of all members.

Dialog handlers

virtual void HandleEvent (NavEventCallbackMessage inSelector, NavCBRec &ioParams)
virtual void HandleNavUserAction (NavUserAction inUserAction)
CP_E_NavDialogResult GetNavDialogResult (NavUserAction inUserAction)

Public Member Functions

Constructor / Destructor
 CP_AskSaveChangesDialog ()
 Constructor.
virtual ~CP_AskSaveChangesDialog () throw ()
 Destructor.

Protected Member Functions

virtual NavDialogRef CreateDialog (NavDialogCreationOptions &inOptions, NavEventUPP inEventUPP, void *inUserData)
virtual void RunPlatformDialog ()

Protected Attributes

CP_FileSelectionCallback * fSelectionCallback
CP_SaveChangesCallback * fSaveChangesCallback
CP_SaveChangesCallback * fRevertCallback
CP_SaveChangesCallback * fDontSaveChangesCallback
CP_SaveChangesCallback * fCancelCallback
NavDialogRef fNavDialog
bool fDialogIsRunning
NavDialogCreationOptions fNavDialogOptions

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_AskSaveChangesDialog::CP_AskSaveChangesDialog (   ) 
 

Constructor.

Exceptions:
none 

CP_AskSaveChangesDialog::~CP_AskSaveChangesDialog (   )  throw () [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

NavDialogRef CP_AskSaveChangesDialog::CreateDialog (  NavDialogCreationOptions &  inOptions,
NavEventUPP  inEventUPP,
void *  inUserData
)  [protected, virtual]
 

Creates the MacOS NavigationServices dialog NavCreateAskSaveChangesDialog to ask the user if they want to save changes.

Parameters:
inOptions Options that control the appearance of the dialog.
inEventUPP Event handling UPP to handle events in this dialog.
inUserData User supplied data. In case it represents a pointer to this object.
Exceptions:
OSErr exceptions
Returns:
NavDialogRef A NavigationServices dialog ref to the created NavigationServices dialog.

Implements CP_FileSystemDialogs_Base.

void CP_AskSaveChangesDialog::RunPlatformDialog (   )  [protected, virtual]
 

Sets up and displays a MessabeBox to ask the user if they want to save changes to the file.

When the user responds to the choices in the dialog, one of the registered slots for this object will be called to handle the result.

Exceptions:
none 
Returns:
void

Reimplemented from CP_FileSystemDialogs_Base.

void CP_FileSystemDialogs_Base::Run (   )  [inherited]
 

Runs the platforms file system / NavigationServices dialog. This calls the virtual RunPlatformDialog which handles the actual dialog, depending on the dialog and OS being used.

Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetModality (  WindowModality  inModality,
CP_Window *  inParent = NULL
)  [inherited]
 

Sets the modality of the dialog, and optionally specifies a parent window to use in positioning the dialog relative to the passed in window.

Parameters:
inModality The WindowModality of the dialog. It can be one of the following:
  • kCP_E_WindowModalityNone,
  • kCP_E_WindowModalitySystemModal,
  • kCP_E_WindowModalityAppModal,
  • kCP_E_WindowModalityWindowModal
inParent The window, if any, that controls the position of the dialog.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetFileSelectionCallback (  CP_FileSelectionCallback *  inCallback  )  [inherited]
 

Sets the callback when the user makes a file selection.

Parameters:
inCallback The function called upon the selection.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetSaveChangesCallback (  CP_SaveChangesCallback *  inCallback  )  [inherited]
 

Sets the callback when the user chooses to save changes.

Parameters:
inCallback The function called when user chooses to save changes.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetRevertCallback (  CP_SaveChangesCallback *  inCallback  )  [inherited]
 

Sets the callback when the user chooses to revert to last saved file.

Parameters:
inCallback The function called when user chooses to revert.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetDontSaveChangesCallback (  CP_SaveChangesCallback *  inCallback  )  [inherited]
 

Sets the callback when the user chooses not to save changes.

Parameters:
inCallback The function called when user chooses not to save changes.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetCancelCallback (  CP_SaveChangesCallback *  inCallback  )  [inherited]
 

Sets the callback when the user cancels Navigation Services dialog.

Parameters:
inCallback The function called when user cancels Navigation Services dialog.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetAppName (  const CP_String &  inAppName  )  [inherited]
 

Sets the applications name for this dialog, if the underlying OS supports the display of the apps name.

Parameters:
inAppName Name of the application using this dialog.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::SetFileName (  const CP_String &  inFileName  )  [inherited]
 

Sets the file name for this dialog, if the underlying OS supports the display of the file name. The file name only applies if this dialog is saving a file, and the user is suppling a default file name.

Parameters:
inFileName Name of the file using this dialog.
Exceptions:
none 
Returns:
void

static pascal void CP_FileSystemDialogs_Base::NavEventProc (  NavEventCallbackMessage  inCallBackSelector,
NavCBRecPtr  inCallBackParms,
void *  inCallBackUD
)  throw () [static, inherited]
 

Options used to control appearance and behavior of Navigation Services dialog.

NavUserAction CP_FileSystemDialogs_Base::GetUserAction (   )  const [inherited]
 

Returns the last user action of the dialog.

Exceptions:
none 
Returns:
NavUserAction The last user action in the dialog.

NavDialogRef CP_FileSystemDialogs_Base::GetNavDialog (   )  [inherited]
 

Returns the MacOS NavDialogRef for the current Navigation Services dialog.

Exceptions:
none 
Returns:
NavDialogRef The MacOS Navigation Services dialog ref.

NavDialogOptionFlags CP_FileSystemDialogs_Base::GetOptionFlags (   )  [inherited]
 

Returns the MacOS NavDialogOptionFlags for the current Navigation Services dialog. These are the options that control the appearance and behavior of the dialog.

Exceptions:
none 
Returns:
NavDialogOptionFlags The MacOS Navigation Services NavDialogOptionFlags.

void CP_FileSystemDialogs_Base::SetOptionFlags (  NavDialogOptionFlags  inFlags  )  [inherited]
 

Sets the MacOS NavDialogOptionFlags for the current Navigation Services dialog. These are the options that control the appearance and behavior of the dialog.

Parameters:
inFlags The flags to be used.
Exceptions:
none 
Returns:
NavDialogOptionFlags The MacOS Navigation Services NavDialogOptionFlags.

void CP_FileSystemDialogs_Base::HandleEvent (  NavEventCallbackMessage  inSelector,
NavCBRec &  ioParams
)  [protected, virtual, inherited]
 

Event handler to handle events in the NavigationServices dialogs.

Parameters:
inSelector The event to be handled.
ioParams Parameters passed between the NavigationServices dialog and this class.
Exceptions:
none 
Returns:
void

Reimplemented in CP_FileSystemDialogs_Reply.

void CP_FileSystemDialogs_Base::HandleNavUserAction (  NavUserAction  inUserAction  )  [protected, virtual, inherited]
 

Called when a kNavCBUserAction call is encountered.

Parameters:
inUserAction The user action that needs to be handled.
Exceptions:
none 
Returns:
void

CP_E_NavDialogResult CP_FileSystemDialogs_Base::GetNavDialogResult (  NavUserAction  inUserAction  )  [protected, inherited]
 

Returns the result of the user dismissing the NavigationServices dialog.

Exceptions:
none 
Returns:
CP_E_NavDialogResult The result of the user dismissing the NavigationServices dialog.

void CP_FileSystemDialogs_Base::HandleNavStart (  NavCBRec &  inOutParams  )  [protected, virtual, inherited]
 

Called when a kNavCBStart call is encountered.

Parameters:
inOutParams Not used.
Exceptions:
none 
Returns:
void

void CP_FileSystemDialogs_Base::HandleNavTerminate (   )  [protected, virtual, inherited]
 

Called when a kNavCBTerminate call is encountered.

Exceptions:
none 
Returns:
void

Member Data Documentation

CP_FileSelectionCallback* CP_FileSystemDialogs_Base::fSelectionCallback [protected, inherited]
 

CP_SaveChangesCallback* CP_FileSystemDialogs_Base::fSaveChangesCallback [protected, inherited]
 

Signal called when the user selects a file.

CP_SaveChangesCallback* CP_FileSystemDialogs_Base::fRevertCallback [protected, inherited]
 

Signal called when the user responds to the AskSaveChanges dialog.

CP_SaveChangesCallback* CP_FileSystemDialogs_Base::fDontSaveChangesCallback [protected, inherited]
 

Signal called when the user responds to the AskRevert dialog.

CP_SaveChangesCallback* CP_FileSystemDialogs_Base::fCancelCallback [protected, inherited]
 

Signal called when the user responds to the AskSaveChanges/AskRevert dialog.

NavDialogRef CP_FileSystemDialogs_Base::fNavDialog [protected, inherited]
 

Signal called when the user responds to the AskSaveChanges/AskRevert dialog.

bool CP_FileSystemDialogs_Base::fDialogIsRunning [protected, inherited]
 

MacOS NavDialogRef for the current Navigation Services dialog.

NavDialogCreationOptions CP_FileSystemDialogs_Base::fNavDialogOptions [protected, inherited]
 

Flag to indicate the dialog is currently running.

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:22 2005 for CPLAT by  doxygen 1.4.0