CP_DialogModality Class Reference

Base class for setting and handling the modality of a CP_Dialog.

Inheritance diagram for CP_DialogModality:

List of all members.

Public Member Functions
Constructor / Destructor
	CP_DialogModality (CP_Window *inWindow)
	Constructor.
virtual	~CP_DialogModality () throw ()
	Destructor.
Display
virtual void	Display (bool)
Dismissal
virtual void	Dismiss ()
Protected Attributes
CP_Window *	fWindow
CP_E_AppStatus	fDialogStatus

---

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_DialogModality::CP_DialogModality (  CP_Window *  inWindow  )

Constructor. Exceptions: none

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

Destructor. Exceptions: none

---

Member Function Documentation

virtual void CP_DialogModality::Display (  bool   )  [virtual]

Display the dialg and begin the event handling loop for the dialog. Parameters: inAutoPosition  Used to control the positioning of the dialog. Exceptions: none  Returns: void Reimplemented in CP_DialogModality_AppModless, CP_DialogModality_AppModal, and CP_DialogModality_WindowModal.

virtual void CP_DialogModality::Dismiss (   )  [virtual]

Handles dismissal of the dialog. Exceptions: none  Returns: void Reimplemented in CP_DialogModality_AppModless, CP_DialogModality_AppModal, and CP_DialogModality_WindowModal.

CP_Window* CP_DialogModality::GetWindow (   )

Returns the window being used by the dialog. Exceptions: none  Returns: CP_Window * The dialogs main window.

void CP_DialogModality::SetWindow (  CP_Window *  inWindow  )

Sets the window. This should be the same window that is the CP_Dialogs main window. Parameters: inWindow  The window used by the dialog. Exceptions: none  Returns: void

CP_E_AppStatus CP_DialogModality::GetDialogStatus (   )  [protected]

Returns the current status of the dialogs event loop. Exceptions: none  Returns: CP_E_AppStatus Indicates the status of the dialogs event handling.

void CP_DialogModality::RunOneEventLoop (  CP_Event< kCP_WINDOW_EVENT, 0 > &  inOutEvent  )  [protected]

Runs one iteration of the Windows main event loop. Normally you do not need to call this method. It is continuously called from Run() to handle event processing in an application. Parameters: inOutEvent  CP_Event containing information from Windows about the event that is happening. On entry this event does not contain valid information. It is filled in during this method with the current event information, and contains the event information when the method exits. Exceptions: none  Returns: void

bool CP_DialogModality::GetAnEvent (  CP_Event< kCP_WINDOW_EVENT, 0 > &  inOutEvent  )  [protected]

Private method used in the RunOneEventLoop method to retrieve information about the current event from a Windows MSG structure as returned by Windows ::GetMessage(). Parameters: inOutEvent  CP_Event containing information from Windows about the event that is happening. On entry this event does not contain valid information. It is filled in during this method with the current event information, and contains the event information when the method exits. Exceptions: none  Returns: bool True if there was an event that occurred, and the inOutEvent parameter now contains valid event information.

void CP_DialogModality::DispatchEvent (  CP_Event< kCP_WINDOW_EVENT, 0 > &  inEvent  )  [protected]

Private method used in the RunOneEventLoop method to dispatch an event under Windows to the corrent Windows event target. Parameters: inEvent  CP_Event containing information from Windows about the event that is happening. Exceptions: none  Returns: void

---

Member Data Documentation

CP_Window* CP_DialogModality::fWindow [protected]

CP_E_AppStatus CP_DialogModality::fDialogStatus [protected]

CP_Window used in displaying the dialog.

---

The documentation for this class was generated from the following files:

• CP_DialogModality.h
• CP_DialogModality.cpp

---