CP_CommandStatus Class Reference

Class used to obtain and set status information about a single command. More...

List of all members.

Public Member Functions
Constructor / Destructor
	CP_CommandStatus ()
	Constructor.
	CP_CommandStatus (const CP_CommandStatus &inOutStatus)
Enabled
bool	IsEnabled ()
void	SetIsEnabled (bool inIsEnabled)
operators
CP_CommandStatus &	operator= (const CP_CommandStatus &inOutStatus)
Text
bool	HasText ()
void	SetText (const CP_String &inText)
CP_String	GetText () const
Private Attributes
bool	fIsEnabled
CP_String	fItemText

---

Detailed Description

---

Constructor & Destructor Documentation

CP_CommandStatus::CP_CommandStatus (   )

Constructor. Exceptions: none

CP_CommandStatus::CP_CommandStatus (  const CP_CommandStatus &  inOutStatus  )

---

Member Function Documentation

bool CP_CommandStatus::IsEnabled (   )

Returns true if the command should be enabled. Exceptions: none  Returns: bool Returns true if the command is enabled.

void CP_CommandStatus::SetIsEnabled (  bool  inIsEnabled  )

Sets the enabled status for this command. Parameters: inIsEnabled  True if this command should be enabled. Exceptions: none  Returns: void

CP_CommandStatus & CP_CommandStatus::operator= (  const CP_CommandStatus &  inOutStatus  )

bool CP_CommandStatus::HasText (   )

Returns true if there is any text associated with this command. Exceptions: none  Returns: bool True if this command has any text associated with it.

void CP_CommandStatus::SetText (  const CP_String &  inText  )

Sets the text associated with this command. This only needs to be called if the command alters a menu, such as undo / redo, otherwise the text is not used. Parameters: inText  The text associated with this command. Exceptions: none  Returns: void

CP_String CP_CommandStatus::GetText (   )  const

Returns the text associated with this command. This is used for commands, such as undo / redo that alter the text of a menu. Exceptions: none  Returns: CP_String const The text associated with this command.

---

Member Data Documentation

bool CP_CommandStatus::fIsEnabled [private]

CP_String CP_CommandStatus::fItemText [private]

Flag to indicate if the command is enabled.

---

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

• CP_M_CommandHandler.h
• CP_M_CommandHandler.cpp

---