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

CP_GetFileDialog Class Reference

Presents the platforms GetFileDialog.

Inheritance diagram for CP_GetFileDialog:

CP_FileSystemDialogs_Reply CP_FileSystemDialogs_Base List of all members.

Dialog handlers

virtual void RunPlatformDialog ()
static UINT APIENTRY CP_SelectFileHook (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)

Public Member Functions

Constructor / Destructor
 CP_GetFileDialog ()
 Constructor.
virtual ~CP_GetFileDialog () throw ()
 Destructor.
Getters
CP_FileSystemSpec_Array GetSelectedFilesList ()

Protected Member Functions

virtual void HandleEvent (NavEventCallbackMessage inSelector, NavCBRec &ioParams)
Dialog handlers
virtual void HandleUserAction (CP_FileSystemDialogs_Base *inSendingDialog, CP_E_NavDialogResult inNavDialogResult)
Dialog handlers
virtual NavDialogRef CreateDialog (NavDialogCreationOptions &inOptions, NavEventUPP inEventUPP, void *inUserData)
virtual void ProcessReply ()

Protected Attributes

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

Static Protected Attributes

static NavObjectFilterUPP fsNavObjectFilterUPP = NULL
static NavPreviewUPP fsNavPreviewUPP = NULL

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_GetFileDialog::CP_GetFileDialog (   ) 
 

Constructor.

Exceptions:
none 

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

Destructor.

Exceptions:
none 

Member Function Documentation

CP_FileSystemSpec_Array CP_GetFileDialog::GetSelectedFilesList (   ) 
 

Returns the list of selected files.

Exceptions:
none 
Returns:
CP_FileSystemSpec_Array Selected files.

void CP_GetFileDialog::HandleUserAction (  CP_FileSystemDialogs_Base *  inSendingDialog,
CP_E_NavDialogResult  inNavDialogResult
)  [protected, virtual]
 

Called when a user has selected a file or files to handle the result

Parameters:
inSendingDialog The dialog that is handling the action.
inNavDialogResult The users action that caused this to be called.
Exceptions:
none 
Returns:
void

Reimplemented from CP_FileSystemDialogs_Reply.

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

Selected files by user

Implements CP_FileSystemDialogs_Base.

void CP_GetFileDialog::ProcessReply (   )  [protected, virtual]
 

Process the reply from the dialog to get all of the user selected items.

Exceptions:
OSErr exceptions
Returns:
void

Reimplemented from CP_FileSystemDialogs_Reply.

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

Sets up and displays the Windows GetOpenFileName dialog to allow the user to select files.

Exceptions:
none 
Returns:
void

Reimplemented from CP_FileSystemDialogs_Reply.

UINT APIENTRY CP_GetFileDialog::CP_SelectFileHook (  HWND  hWnd,
UINT  uMsg,
WPARAM  wParam,
LPARAM  lParam
)  [static, protected]
 

Callback used in the GetFile dialog under Windows to provide setup the open file dialog position.

Parameters:
hWnd The dialogs window.
uMsg The message to handle.
wParam Not used.
lParam The lParam of the message.
Exceptions:
none 
Returns:
UINT The result of the event handling.

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

NavigationServices preview UPP.

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::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_FileSystemSpec_Array CP_GetFileDialog::fSelectedFiles [protected]
 

CPLAT_Begin_Namespace_CPLAT NavObjectFilterUPP CP_FileSystemDialogs_Reply::fsNavObjectFilterUPP = NULL [static, protected, inherited]
 

NavPreviewUPP CP_FileSystemDialogs_Reply::fsNavPreviewUPP = NULL [static, protected, inherited]
 

NavigationServices object filter UPP.

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:42 2005 for CPLAT by  doxygen 1.4.0