Detailed Description
Class used to specify action item overrides.
The IActionItemOverride class is an abstract base class to be used to create an action item override. An action item override is an action item that will only execute as long as the action item keyboard shortcut is held. Once released the override will revert back to the state it was in before the action item executed. In order for an override to occur instead of an action item, the client needs to create an instance of a class that implements the virtual functions defined in this base class, and then activate it by calling IActionItemOverrideManager::ActivateActionItemOverride.
- See also:
- IActionItemOverrideManager
#include <IActionItemOverrideManager.h>
Public Member Functions |
|
| virtual | ~IActionItemOverride () |
| Virtual Deconstructor that allows the
IctionItemOverrideManager to delete IActionItemOverride
objects correctly. |
|
| virtual BOOL | IsOverrideActive ()=0 |
| Function that returns whether or not we this
override is active. |
|
| virtual BOOL | StartOverride ()=0 |
| Function that's called when we start the
action item override. |
|
| virtual BOOL | EndOverride ()=0 |
| Function that's called when we end the
action item override. |
|
Constructor & Destructor Documentation
| virtual ~IActionItemOverride | ( | ) | [inline, virtual] |
Virtual Deconstructor that allows the IctionItemOverrideManager to delete IActionItemOverride objects correctly.
{};
Member Function Documentation
| virtual BOOL IsOverrideActive | ( | ) | [pure virtual] |
Function that returns whether or not we this override is active.
- Returns:
- TRUE if the override is active, FALSE if otherwise.
| virtual BOOL StartOverride | ( | ) | [pure virtual] |
Function that's called when we start the action item override.
Function that's called when we start the action item override. Usually the subclass that overrides this method will store the state(s) that the override will change and then perform the action, usually as if ActionItem::ExecuteAction was called.
- Returns:
- TRUE if we started the override correctly, FALSE otherwise
| virtual BOOL EndOverride | ( | ) | [pure virtual] |
Function that's called when we end the action item override.
Function that's called when we end the action item override. Usually the subclass that overrides this method will restore the state(s) that were stored when IActionItemOverride::StartOverride() was cas called.
- Returns:
- TRUE if we ended the override correctly, FALSE otherwise
