CP_UIClasses_Application Class Reference

Application class for the UIClasses demo.

List of all members.

Public Member Functions
Constructor / Destructor
	CP_UIClasses_Application ()
	Constructor.
virtual	~CP_UIClasses_Application () throw ()
	Destructor.
Protected Member Functions
AboutBox
virtual CPLAT::CP_String	GetAboutBoxDescription () const
Commands
virtual void	HandleNewUpdateCommandStatusCommand (CPLAT::CP_CommandStatus &inOutCommandStatus, bool &, CPLAT::CP_CommandNo &)
virtual void	HandleNewCommand (CPLAT::OSStatus &inOutStatus, CPLAT::CP_CommandNo &inCommandNo)
virtual void	HandleOpenApplication ()
Private Types
typedef CPLAT::CP_Application< CPLAT::CP_DocumentPolicy_None, CPLAT::CP_PrintPolicy_None, CPLAT::CP_UndoPolicy_None >	inherited
Private Member Functions
Command Handlers
void	CreateMainWindow (CPLAT::OSStatus &inOutStatus, CPLAT::CP_CommandNo &inCommandNo)
Views
CPLAT::CP_View *	CreateButtonView (CPLAT::CP_View *inSuperview)
CPLAT::CP_View *	CreateTracksView (CPLAT::CP_View *inSuperview)
CPLAT::CP_View *	CreateGroupsView (CPLAT::CP_View *inSuperview)
CPLAT::CP_View *	CreateMiscView (CPLAT::CP_View *inSuperview)
PopupMenus
void	InitPopupMenuCommands ()
void	HandlePopupCommand (CPLAT::OSStatus &inOutStatus, CPLAT::CP_CommandNo &inCommandNo)
Slots
void	ControlClicked (CPLAT::CP_DataValueHolder &inValue, CPLAT::OSStatus &inOutStatus)

---

Member Typedef Documentation

typedef CPLAT::CP_Application<CPLAT::CP_DocumentPolicy_None, CPLAT::CP_PrintPolicy_None, CPLAT::CP_UndoPolicy_None> CP_UIClasses_Application::inherited [private]

---

Constructor & Destructor Documentation

CP_UIClasses_Application::CP_UIClasses_Application (   )

Constructor. Exceptions: none

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

Destructor. Exceptions: none

---

Member Function Documentation

CPLAT::CP_String CP_UIClasses_Application::GetAboutBoxDescription (   )  const [protected, virtual]

Return the string that describes the purpose of the application in the AboutBox. Exceptions: none  Returns: CP_String const The description, displayed in the about box.

virtual void CP_UIClasses_Application::HandleNewUpdateCommandStatusCommand (  CPLAT::CP_CommandStatus &  inOutCommandStatus, bool &  , CPLAT::CP_CommandNo &  )  [protected, virtual]

void CP_UIClasses_Application::HandleNewCommand (  CPLAT::OSStatus &  inOutStatus, CPLAT::CP_CommandNo &  inCommandNo )  [protected, virtual]

Override the New command handler to create new windows. Since this application is using a NULL document policy, we don't normally have the New menu item enabled. Returns: inOutStatus Return the OSStatus of this operation here. inCommandNo The command being executed, in this case CP_CMD_New. Exceptions: none  Returns: void

void CP_UIClasses_Application::HandleOpenApplication (   )  [protected, virtual]

Called when the application is starting up. We take this opportunity to create our initial window and views. In this demo, we will open the buttons window. Exceptions: none  Returns: void

void CP_UIClasses_Application::CreateMainWindow (  CPLAT::OSStatus &  inOutStatus, CPLAT::CP_CommandNo &  inCommandNo )  [private]

Called when the application opens andn we choose New. This will create the main window that contains a tab view to show the various UI elements Returns: inOutStatus Not used. inCommandNo Not used. Exceptions: none  - all exceptions are trapped in this method. Returns: void

CPLAT::CP_View * CP_UIClasses_Application::CreateButtonView (  CPLAT::CP_View *  inSuperview  )  [private]

This is used to create a CP_View that serves as the root or container view for the buttons tab. Returns: inSuperview The view that will contain this view, in this case it is the tab view. Exceptions: none  Returns: CP_View The outter or containing CP_View that will contain any of the subviews displayed on the content area of tab one.

CPLAT::CP_View * CP_UIClasses_Application::CreateTracksView (  CPLAT::CP_View *  inSuperview  )  [private]

This is used to create a CP_View that serves as the root or container view for the tabs window, tracker / progresss type controls. Returns: inSuperview The view that will contain this view, in this case it is the tab view. Exceptions: none  Returns: CP_View The outter or containing CP_View that will contain any of the subviews displayed on the content area of tab two.

CPLAT::CP_View * CP_UIClasses_Application::CreateGroupsView (  CPLAT::CP_View *  inSuperview  )  [private]

This is used to create a CP_View that serves as the root or container view for the tabs window, group view. Returns: inSuperview The view that will contain this view, in this case it is the tab view. Exceptions: none  Returns: CP_View The outter or containing CP_View that will contain any of the subviews displayed on the content area of tab two.

CPLAT::CP_View * CP_UIClasses_Application::CreateMiscView (  CPLAT::CP_View *  inSuperview  )  [private]

This is used to create a CP_View that serves as the root or container view for the tabs window, misc elemennts. Returns: inSuperview The view that will contain this view, in this case it is the tab view. Exceptions: none  Returns: CP_View The outter or containing CP_View that will contain any of the subviews displayed on the content area of tab two.

void CP_UIClasses_Application::InitPopupMenuCommands (   )  [private]

Initialize the popup menus by populating the menu with the commands numbers they will respond to. In this demo we use 2000 as the base of the command numbers, and increment by the items index. These will be the commands sent when the user selects an item from one of these popup menus. Exceptions: none  Returns: void

void CP_UIClasses_Application::HandlePopupCommand (  CPLAT::OSStatus &  inOutStatus, CPLAT::CP_CommandNo &  inCommandNo )  [private]

Call when the user selects an item from one of the popup menus. In this demo we will show an alert with the message "Popup menu selected" and then the command number. Returns: inOutStatus Not used. inCommandNo The command number associated with the selected item. Exceptions: none  Returns: void

void CP_UIClasses_Application::ControlClicked (  CPLAT::CP_DataValueHolder &  inValue, CPLAT::OSStatus &  inOutStatus )  [private]

Generic slot that gets called when controls are clicked. This will post an alert that displies the value of the control, along with the command that the sending control used when calling this slot. Returns: inValue Holds a CP_S_ControlClickedInfo structure that describes information about the sending control and value from the control that was clicked. inOutStatus Not used. Exceptions: none  Returns: void

---

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

• CP_UIClasses_App.h
• CP_UIClasses_App.cpp

---