Class: TStandardControlActions

Declaration: StandardControlActions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardActions

Inherited By:

None.

Purpose:

TStandardControlActions derives from TStandardActions and is used primarily by the view action handler function, and by the creators of view actions to set their event types to one of the well-known types.

Instantiation:

There should be no need to instantiate one of these because all of its member functions are static.

Deriving Classes:

Do not derive from this class. This class exists simply to scope some static variables. If new event types need to be invented then they should be provided inside the TAction derived class that uses them.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStandardControlActions::IsValueChanged

static bool IsValueChanged (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kValueChanged.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kValueChanged static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardControlActions::IsSelect

static bool IsSelect (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kSelect.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kSelect static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardControlActions::IsPress

static bool IsPress (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kPressed.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kPressed static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardControlActions::IsRelease

static bool IsRelease (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kReleased.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kReleased static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardControlActions::IsEnable

static bool IsEnable (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kEnabled.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kEnabled static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardControlActions::IsDisable

static bool IsDisable (const TViewAction & action)

Interface Category:

API.

Purpose:

Determines whether or not the event type of the specified action is equal to kDisabled.

Calling Context:

Call this function directly.

Parameters:

const TViewAction & action -The action whose event type is checked.

Return Value:

Returns true if the action's event type is equal to the kDisabled static const data member, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.