This reference page is linked to from the following overview topics: Deferred Loading of Plug-ins.
Detailed Description
The interface for managing action item overrides.
This manager allows action item overrides to be activated, deactivated and retrieved. This static function-published interface is registered as a core interface. You retrieve this interface by calling static_cast<IActionItemOverrideManager*>(GetCOREInterface(IACTIONITEMOVERRIDEMANAGER_INTERFACE )). Note that once an IActionOverrideItem is managed by this interface by activating it, it then will get deleted by this interface.
- See also:
- IActionItemOverride
#include <IActionItemOverrideManager.h>
Public Member Functions |
|
| virtual void | SetOverridesActive (BOOL active)=0 |
| Function to set action item overrides
active. |
|
| virtual BOOL | GetOverridesActive (void) const =0 |
| Get whether or not action item overrides are
globally active or not. |
|
| virtual void | SetTimeToStartOverride (float secs)=0 |
| Function to set how long a key must be
pressed before a suitable action item becomes an override. |
|
| virtual float | GetTimeToStartOverride () const =0 |
| How much time, in seconds, that we need to
hold a key before a suitable ction item becomes an override.
|
|
| virtual void | RegisterActionItemOverride (ActionItem *aItem, MSTR &overrideDescription)=0 |
| Function to register an action item as a
possible override. |
|
| virtual void | UnregisterActionItemOverride (ActionItem *aItem)=0 |
| Function to unregister an action item as a
possible override. |
|
| virtual BOOL | IsActionItemRegistered (ActionItem *aItem, MSTR &description)=0 |
| Function to see if an action item has been
registered, and thus may eventually be activated. |
|
| virtual void | ActivateActionItemOverride (ActionItem *aItem, IActionItemOverride *aItemOverride)=0 |
| Function to activate a particular action
item with a particular override, which then allows the action item
to work like an override also. |
|
| virtual void | DeactivateActionItemOverride (ActionItem *aItem)=0 |
| Function to deactivate an action item
override. |
|
| virtual IActionItemOverride * | FindOverride (ActionItem *aItem)=0 |
| Find a particular activated IActionItemOverride
given a particular ActionItem.
|
|
| virtual ActionItem * | GetOverridingActionItem () const =0 |
| Returns the action item that is currently
being overriden. |
|
Member Function Documentation
| virtual void SetOverridesActive | ( | BOOL | active | ) | [pure virtual] |
Function to set action item overrides active.
- Parameters:
-
[in] active If TRUE then action item overrides may be active, if FALSE then all action overrides will be disabled.
| virtual BOOL GetOverridesActive | ( | void | ) | const [pure virtual] |
Get whether or not action item overrides are globally active or not.
- Returns:
- TRUE if action item overrides may be active, FALSE if otherwise.
| virtual void SetTimeToStartOverride | ( | float | secs | ) | [pure virtual] |
Function to set how long a key must be pressed before a suitable action item becomes an override.
- Parameters:
-
[in] secs The number of seconds that a key must be pressed and held before an action item becomes an override.
| virtual float GetTimeToStartOverride | ( | ) | const [pure virtual] |
How much time, in seconds, that we need to hold a key before a suitable ction item becomes an override.
- Returns:
- Returns how many seconds that we need to hold a key before an action time becomes an override.
| virtual void RegisterActionItemOverride | ( | ActionItem * | aItem, |
| MSTR & | overrideDescription | ||
| ) | [pure virtual] |
Function to register an action item as a possible override.
Function to register an action item as a possible override. The purpose of this is to inform the system of a possible override so that the action item may get highlighted in the customize UI dialog.
- Parameters:
-
[in] aItem The action item that may have an override. [in] overrideDescription Text description of what the override does.
| virtual void UnregisterActionItemOverride | ( | ActionItem * | aItem | ) | [pure virtual] |
Function to unregister an action item as a possible override.
Function to unregister an action item as a possible override. The client should call this when either an action item will no longer be overridable of if the action item will get removed from the action table.
- See also:
- ActionTable::DeleteOperation.
- Parameters:
-
[in] aItem The action item that we want to unregister. Nothing happens if the action item was never registered.
| virtual BOOL IsActionItemRegistered | ( | ActionItem * | aItem, |
| MSTR & | description | ||
| ) | [pure virtual] |
Function to see if an action item has been registered, and thus may eventually be activated.
- Parameters:
-
[in] aItem The aciton item that may have an override. [out] description The text description of the override.
- Returns:
- Return TRUE if the ActionItem is registered, otherwise return FALSE.
| virtual void ActivateActionItemOverride | ( | ActionItem * | aItem, |
| IActionItemOverride * | aItemOverride | ||
| ) | [pure virtual] |
Function to activate a particular action item with a particular override, which then allows the action item to work like an override also.
Function to activate a particular action item with a particular override. This function must be called in order for a particular action item to work like an override.
- Parameters:
-
[in] aItem The action item that will be associated with an override. [in] aItemOverride The action item override that will override the action item when a key is held. Note that once a IActionItemOverride object is activated the deletion of this object is now the responsibility of the IActionItemOverrideManager, and so the client shouldn't delete it also. Usually the action item override will be activated after IActionManger::ActivateActionTable is called.
| virtual void DeactivateActionItemOverride | ( | ActionItem * | aItem | ) | [pure virtual] |
Function to deactivate an action item override.
Function to unactive an action item with a corresponding action item override. Note that the activated IActionItemOverride instance will get deleted when this occurs. For efficiency, a user should unactivate their action item and action item overrides whenever they would also deactivate an action table via IActionManager::DeactiveActionTable, usually within a Animatable::EndEditParams function call.
- See also:
- IActionManager::DeactivateActionTable
- Parameters:
-
[in] aItem The action item that will be unactivated. The corresponding IActionActionItemOverride will also get removed and deleted.
| virtual IActionItemOverride* FindOverride | ( | ActionItem * | aItem | ) | [pure virtual] |
Find a particular activated IActionItemOverride given a particular ActionItem.
- Returns:
- Returns the IActionItemOverride object that's been activated with IActionItemOverrideManager::ActivateActionItemOverride. If none exists, it will return NULL.
| virtual ActionItem* GetOverridingActionItem | ( | ) | const [pure virtual] |
Returns the action item that is currently being overriden.
- Returns:
- Returns a pointer to the ActionItem that is currently being overriden. If no action item is being overriden, it return NULL.
