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

CP_AboutBox Class Reference

A class to handle display of an AboutBox in CPLAT applications.

Inheritance diagram for CP_AboutBox:

CP_M_DeferredTask CP_SigSlot::CP_SlotObject List of all members.

Public Member Functions

void disconnect_all ()
void signal_connect (CP_Signal *inSender)
void signal_disconnect (CP_Signal *inSender)
Constructor / Destructor
 CP_AboutBox (CP_Application_Imp *inOwnerApp)
 Constructor.
virtual ~CP_AboutBox () throw ()
 Destructor.
Display
void Display (const CP_String &inDescription=CP_String(""))
Setters
void SetOwnerApp (CP_Application_Imp *inOwnerApp)
Display
void DisplayDefault (const CP_String &inDescription=CP_String(""))
void Display (const CP_String &inNibName, const CP_String &inWindowName, UInt32 inDefaultButtonID)
Display
void DisplayDefault (const CP_String &inDescription=CP_String(""))

Static Public Member Functions

Instance
static CP_AboutBoxInstance ()

Protected Attributes

CP_Application_ImpfOwnerApp
CP_WindowfAboutBoxWindow
sender_set fSenders

Private Member Functions

Task
void HandleDefaualtButton_Slot (CP_DataValueHolder &inDataValue, OSStatus &inOutStatus)

Static Private Attributes

static CP_AboutBoxfsInstance = NULL

Constructor & Destructor Documentation

CP_AboutBox::CP_AboutBox CP_Application_Imp inOwnerApp  ) 
 

Constructor.

Exceptions:
none 

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

Destructor.

Exceptions:
none 


Member Function Documentation

CP_AboutBox * CP_AboutBox::Instance  )  [static]
 

Returns the single instance of this class.

Exceptions:
none 
Returns:
CP_AboutBox * Returns the single instance of this class.

void CP_AboutBox::Display const CP_String inDescription = CP_String("")  ) 
 

Displays the about box.

Parameters:
inDescription Description of the application displayed in the about box.
Exceptions:
none 
Returns:
void

void CP_AboutBox::SetOwnerApp CP_Application_Imp inOwnerApp  ) 
 

Sets the application object that we are displaying the about box for.

Parameters:
inOwnerApp The app to display the about box for.
Exceptions:
none 
Returns:
void

void CP_AboutBox::HandleDefaualtButton_Slot CP_DataValueHolder inDataValue,
OSStatus inOutStatus
[private]
 

Slot called when the user presses the default button to cause the about box to go away.

Parameters:
inDataValue Not used.
inOutStatus Returns CP_noErr to indicate success.
Exceptions:
none 
Returns:
void

void CP_AboutBox::DisplayDefault const CP_String inDescription = CP_String("")  ) 
 

Window displaying the about box.

void CP_AboutBox::Display const CP_String inNibName,
const CP_String inWindowName,
UInt32  inDefaultButtonID
 

Displays the about box. This is a MacOS version that uses a nib file.

Parameters:
inNibName The name of the nib file with the about box.
inWindowName Name of the window in the nib.
inDefaultButtonID View identifier for the default push button to cause the about box to be dismissed.
Exceptions:
none 
Returns:
void

void CP_AboutBox::DisplayDefault const CP_String inDescription = CP_String("")  ) 
 

void CP_M_DeferredTask::DoTask  )  [inherited]
 

Handle our task.

Exceptions:
none 

virtual void CP_M_DeferredTask::OnDoTask  )  [protected, virtual, inherited]
 

Subclasses override to handle the specific task when called.

Exceptions:
none 
Returns:
void

Reimplemented in CP_DeferredViewDeleter.

void CP_SigSlot::CP_SlotObject::disconnect_all  )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_connect CP_Signal inSender  )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_disconnect CP_Signal inSender  )  [inherited]
 


Member Data Documentation

CP_AboutBox * CP_AboutBox::fsInstance = NULL [static, private]
 

CP_Application_Imp* CP_AboutBox::fOwnerApp [protected]
 

The single instance of this class.

CP_Window* CP_AboutBox::fAboutBoxWindow [protected]
 

Owner application class.

sender_set CP_SigSlot::CP_SlotObject::fSenders [protected, inherited]
 


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