A table of action items that can be used by plug-ins to export tables of action items that can be used by the UI to attach to keyboard shortcuts, assigned to toolbar buttons, and add to menus. More...
#include <actiontable_REMOTE_92.h>
Inheritance diagram for ActionTable:
Public Member Functions | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name, HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| This constructor builds the action table using an array of descriptors. | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name) |
| This constructor builds a new empty action table with the given ID, context ID and name. | |
| virtual CoreExport | ~ActionTable () |
| Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use. | |
| virtual CoreExport MSTR & | GetName () |
| Returns the name of the action table. | |
| virtual CoreExport ActionTableId | GetId () |
| Returns the ActionTableID. | |
| virtual CoreExport ActionContextId | GetContextId () |
| Returns the ActionContextId. | |
| virtual CoreExport ActionCallback * | GetCallback () |
| Get the current callback associated with this table. | |
| virtual CoreExport void | SetCallback (ActionCallback *pCallback) |
| Sets the callback object used by this ActionTable. | |
| virtual CoreExport int | Count () |
| Returns the number of ActionItems in the table. | |
| virtual CoreExport ActionItem * | operator[] (int i) |
| Returns a pointer to the nth ActionItem. | |
| virtual CoreExport ActionItem * | GetAction (int cmdId) |
| Returns a pointer to the ActionItem associated with the command ID passed. | |
| virtual CoreExport ActionItem * | GetActionByIndex (int index) |
| Returns a pointer to the nth ActionItem using the same algorithm as the operator[]. | |
| virtual CoreExport void | AppendOperation (ActionItem *pAction) |
| Appends an ActionItem to the table. | |
| virtual CoreExport BOOL | DeleteOperation (ActionItem *pAction) |
| Removes an operation from the table. | |
| virtual CoreExport void | DeleteThis () |
| Deletes this ActionItem. | |
| virtual CoreExport BOOL | GetButtonText (int cmdId, MSTR &buttonText) |
| Retrieves the text that will be used when the ActionItem is on a text button. | |
| virtual CoreExport BOOL | GetMenuText (int cmdId, MSTR &menuText) |
| Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). | |
| virtual CoreExport BOOL | GetDescriptionText (int cmdId, MSTR &descText) |
| Retrieves the text that is used for tool tips and menu help. | |
| virtual CoreExport BOOL | IsChecked (int cmdId) |
| Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state. | |
| virtual CoreExport BOOL | IsIndeterminate (int cmdId) |
| Returns TRUE if the menu item should be indeterminate | |
| virtual CoreExport BOOL | IsItemVisible (int cmdId) |
| Determines if an item is to be visible on a menu. | |
| virtual CoreExport BOOL | IsEnabled (int cmdId) |
| Determines if the operation is currently enabled and available. | |
| virtual CoreExport void | WritePersistentActionId (int cmdId, MSTR &outIdString) |
| Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files. | |
| virtual CoreExport int | ReadPersistentActionId (const MSTR &idString) |
| Converts an action table string id to the action items numeric id. | |
| __declspec (deprecated) virtual int ReadPersistentActionId(MSTR &idString) MAX_SEALED | |
| virtual CoreExport MaxIcon * | GetIcon (int cmdId) |
| Returns an optional icon for the command, or NULL if there is none. | |
| CoreExport void | BuildActionTable (HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| Fills the action table with the given action descriptions. | |
| virtual CoreExport ActionItem * | GetCurrentAssignment (ACCEL accel) |
| Gets the action assigned to the given accelerator, if any. | |
| virtual CoreExport void | AssignKey (int cmdId, ACCEL accel) |
| Assigns the command to the given accelerator. | |
| virtual CoreExport void | RemoveShortcutFromTable (ACCEL accel) |
| Removes the given assignment from the shortcut table. | |
| CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| CoreExport FPInterfaceDesc * | GetDesc () |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual CoreExport Interface_ID | GetID () |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name, HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| This constructor builds the action table using an array of descriptors. | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name) |
| This constructor builds a new empty action table with the given ID, context ID and name. | |
| virtual CoreExport | ~ActionTable () |
| Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use. | |
| virtual CoreExport MSTR & | GetName () |
| Returns the name of the action table. | |
| virtual CoreExport ActionTableId | GetId () |
| Returns the ActionTableID. | |
| virtual CoreExport ActionContextId | GetContextId () |
| Returns the ActionContextId. | |
| virtual CoreExport ActionCallback * | GetCallback () |
| Get the current callback associated with this table. | |
| virtual CoreExport void | SetCallback (ActionCallback *pCallback) |
| Sets the callback object used by this ActionTable. | |
| virtual CoreExport int | Count () |
| Returns the number of ActionItems in the table. | |
| virtual CoreExport ActionItem * | operator[] (int i) |
| Returns a pointer to the nth ActionItem. | |
| virtual CoreExport ActionItem * | GetAction (int cmdId) |
| Returns a pointer to the ActionItem associated with the command ID passed. | |
| virtual CoreExport ActionItem * | GetActionByIndex (int index) |
| Returns a pointer to the nth ActionItem using the same algorithm as the operator[]. | |
| virtual CoreExport void | AppendOperation (ActionItem *pAction) |
| Appends an ActionItem to the table. | |
| virtual CoreExport BOOL | DeleteOperation (ActionItem *pAction) |
| Removes an operation from the table. | |
| virtual CoreExport void | DeleteThis () |
| Deletes this ActionItem. | |
| virtual CoreExport BOOL | GetButtonText (int cmdId, MSTR &buttonText) |
| Retrieves the text that will be used when the ActionItem is on a text button. | |
| virtual CoreExport BOOL | GetMenuText (int cmdId, MSTR &menuText) |
| Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). | |
| virtual CoreExport BOOL | GetDescriptionText (int cmdId, MSTR &descText) |
| Retrieves the text that is used for tool tips and menu help. | |
| virtual CoreExport BOOL | IsChecked (int cmdId) |
| Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state. | |
| virtual CoreExport BOOL | IsIndeterminate (int cmdId) |
| Returns TRUE if the menu item should be indeterminate | |
| virtual CoreExport BOOL | IsItemVisible (int cmdId) |
| Determines if an item is to be visible on a menu. | |
| virtual CoreExport BOOL | IsEnabled (int cmdId) |
| Determines if the operation is currently enabled and available. | |
| virtual CoreExport void | WritePersistentActionId (int cmdId, MSTR &outIdString) |
| Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files. | |
| virtual CoreExport int | ReadPersistentActionId (const MSTR &idString) |
| Converts an action table string id to the action items numeric id. | |
| __declspec (deprecated) virtual int ReadPersistentActionId(MSTR &idString) MAX_SEALED | |
| virtual CoreExport MaxIcon * | GetIcon (int cmdId) |
| Returns an optional icon for the command, or NULL if there is none. | |
| CoreExport void | BuildActionTable (HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| Fills the action table with the given action descriptions. | |
| virtual CoreExport ActionItem * | GetCurrentAssignment (ACCEL accel) |
| Gets the action assigned to the given accelerator, if any. | |
| virtual CoreExport void | AssignKey (int cmdId, ACCEL accel) |
| Assigns the command to the given accelerator. | |
| virtual CoreExport void | RemoveShortcutFromTable (ACCEL accel) |
| Removes the given assignment from the shortcut table. | |
| CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| CoreExport FPInterfaceDesc * | GetDesc () |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual CoreExport Interface_ID | GetID () |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name, HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| This constructor builds the action table using an array of descriptors. | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name) |
| This constructor builds a new empty action table with the given ID, context ID and name. | |
| virtual CoreExport | ~ActionTable () |
| Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use. | |
| virtual CoreExport MSTR & | GetName () |
| Returns the name of the action table. | |
| virtual CoreExport ActionTableId | GetId () |
| Returns the ActionTableID. | |
| virtual CoreExport ActionContextId | GetContextId () |
| Returns the ActionContextId. | |
| virtual CoreExport ActionCallback * | GetCallback () |
| Get the current callback associated with this table. | |
| virtual CoreExport void | SetCallback (ActionCallback *pCallback) |
| Sets the callback object used by this ActionTable. | |
| virtual CoreExport int | Count () |
| Returns the number of ActionItems in the table. | |
| virtual CoreExport ActionItem * | operator[] (int i) |
| Returns a pointer to the nth ActionItem. | |
| virtual CoreExport ActionItem * | GetAction (int cmdId) |
| Returns a pointer to the ActionItem associated with the command ID passed. | |
| virtual CoreExport ActionItem * | GetActionByIndex (int index) |
| Returns a pointer to the nth ActionItem using the same algorithm as the operator[]. | |
| virtual CoreExport void | AppendOperation (ActionItem *pAction) |
| Appends an ActionItem to the table. | |
| virtual CoreExport BOOL | DeleteOperation (ActionItem *pAction) |
| Removes an operation from the table. | |
| virtual CoreExport void | DeleteThis () |
| Deletes this ActionItem. | |
| virtual CoreExport BOOL | GetButtonText (int cmdId, MSTR &buttonText) |
| Retrieves the text that will be used when the ActionItem is on a text button. | |
| virtual CoreExport BOOL | GetMenuText (int cmdId, MSTR &menuText) |
| Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). | |
| virtual CoreExport BOOL | GetDescriptionText (int cmdId, MSTR &descText) |
| Retrieves the text that is used for tool tips and menu help. | |
| virtual CoreExport BOOL | IsChecked (int cmdId) |
| Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state. | |
| virtual CoreExport BOOL | IsIndeterminate (int cmdId) |
| Returns TRUE if the menu item should be indeterminate | |
| virtual CoreExport BOOL | IsItemVisible (int cmdId) |
| Determines if an item is to be visible on a menu. | |
| virtual CoreExport BOOL | IsEnabled (int cmdId) |
| Determines if the operation is currently enabled and available. | |
| virtual CoreExport void | WritePersistentActionId (int cmdId, MSTR &outIdString) |
| Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files. | |
| virtual CoreExport int | ReadPersistentActionId (const MSTR &idString) |
| Converts an action table string id to the action items numeric id. | |
| __declspec (deprecated) virtual int ReadPersistentActionId(MSTR &idString) MAX_SEALED | |
| virtual CoreExport MaxIcon * | GetIcon (int cmdId) |
| Returns an optional icon for the command, or NULL if there is none. | |
| CoreExport void | BuildActionTable (HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| Fills the action table with the given action descriptions. | |
| virtual CoreExport ActionItem * | GetCurrentAssignment (ACCEL accel) |
| Gets the action assigned to the given accelerator, if any. | |
| virtual CoreExport void | AssignKey (int cmdId, ACCEL accel) |
| Assigns the command to the given accelerator. | |
| virtual CoreExport void | RemoveShortcutFromTable (ACCEL accel) |
| Removes the given assignment from the shortcut table. | |
| CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| CoreExport FPInterfaceDesc * | GetDesc () |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual CoreExport Interface_ID | GetID () |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name, HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| This constructor builds the action table using an array of descriptors. | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name) |
| This constructor builds a new empty action table with the given ID, context ID and name. | |
| virtual CoreExport | ~ActionTable () |
| Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use. | |
| virtual CoreExport MSTR & | GetName () |
| Returns the name of the action table. | |
| virtual CoreExport ActionTableId | GetId () |
| Returns the ActionTableID. | |
| virtual CoreExport ActionContextId | GetContextId () |
| Returns the ActionContextId. | |
| virtual CoreExport ActionCallback * | GetCallback () |
| Get the current callback associated with this table. | |
| virtual CoreExport void | SetCallback (ActionCallback *pCallback) |
| Sets the callback object used by this ActionTable. | |
| virtual CoreExport int | Count () |
| Returns the number of ActionItems in the table. | |
| virtual CoreExport ActionItem * | operator[] (int i) |
| Returns a pointer to the nth ActionItem. | |
| virtual CoreExport ActionItem * | GetAction (int cmdId) |
| Returns a pointer to the ActionItem associated with the command ID passed. | |
| virtual CoreExport ActionItem * | GetActionByIndex (int index) |
| Returns a pointer to the nth ActionItem using the same algorithm as the operator[]. | |
| virtual CoreExport void | AppendOperation (ActionItem *pAction) |
| Appends an ActionItem to the table. | |
| virtual CoreExport BOOL | DeleteOperation (ActionItem *pAction) |
| Removes an operation from the table. | |
| virtual CoreExport void | DeleteThis () |
| Deletes this ActionItem. | |
| virtual CoreExport BOOL | GetButtonText (int cmdId, MSTR &buttonText) |
| Retrieves the text that will be used when the ActionItem is on a text button. | |
| virtual CoreExport BOOL | GetMenuText (int cmdId, MSTR &menuText) |
| Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). | |
| virtual CoreExport BOOL | GetDescriptionText (int cmdId, MSTR &descText) |
| Retrieves the text that is used for tool tips and menu help. | |
| virtual CoreExport BOOL | IsChecked (int cmdId) |
| Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state. | |
| virtual CoreExport BOOL | IsIndeterminate (int cmdId) |
| Returns TRUE if the menu item should be indeterminate | |
| virtual CoreExport BOOL | IsItemVisible (int cmdId) |
| Determines if an item is to be visible on a menu. | |
| virtual CoreExport BOOL | IsEnabled (int cmdId) |
| Determines if the operation is currently enabled and available. | |
| virtual CoreExport void | WritePersistentActionId (int cmdId, MSTR &outIdString) |
| Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files. | |
| virtual CoreExport int | ReadPersistentActionId (const MSTR &idString) |
| Converts an action table string id to the action items numeric id. | |
| __declspec (deprecated) virtual int ReadPersistentActionId(MSTR &idString) MAX_SEALED | |
| virtual CoreExport MaxIcon * | GetIcon (int cmdId) |
| Returns an optional icon for the command, or NULL if there is none. | |
| CoreExport void | BuildActionTable (HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| Fills the action table with the given action descriptions. | |
| virtual CoreExport ActionItem * | GetCurrentAssignment (ACCEL accel) |
| Gets the action assigned to the given accelerator, if any. | |
| virtual CoreExport void | AssignKey (int cmdId, ACCEL accel) |
| Assigns the command to the given accelerator. | |
| virtual CoreExport void | RemoveShortcutFromTable (ACCEL accel) |
| Removes the given assignment from the shortcut table. | |
| CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| CoreExport FPInterfaceDesc * | GetDesc () |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual CoreExport Interface_ID | GetID () |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name, HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| This constructor builds the action table using an array of descriptors. | |
| CoreExport | ActionTable (ActionTableId id, ActionContextId contextId, const MSTR &name) |
| This constructor builds a new empty action table with the given ID, context ID and name. | |
| virtual CoreExport | ~ActionTable () |
| Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use. | |
| virtual CoreExport MSTR & | GetName () |
| Returns the name of the action table. | |
| virtual CoreExport ActionTableId | GetId () |
| Returns the ActionTableID. | |
| virtual CoreExport ActionContextId | GetContextId () |
| Returns the ActionContextId. | |
| virtual CoreExport ActionCallback * | GetCallback () |
| Get the current callback associated with this table. | |
| virtual CoreExport void | SetCallback (ActionCallback *pCallback) |
| Sets the callback object used by this ActionTable. | |
| virtual CoreExport int | Count () |
| Returns the number of ActionItems in the table. | |
| virtual CoreExport ActionItem * | operator[] (int i) |
| Returns a pointer to the nth ActionItem. | |
| virtual CoreExport ActionItem * | GetAction (int cmdId) |
| Returns a pointer to the ActionItem associated with the command ID passed. | |
| virtual CoreExport ActionItem * | GetActionByIndex (int index) |
| Returns a pointer to the nth ActionItem using the same algorithm as the operator[]. | |
| virtual CoreExport void | AppendOperation (ActionItem *pAction) |
| Appends an ActionItem to the table. | |
| virtual CoreExport BOOL | DeleteOperation (ActionItem *pAction) |
| Removes an operation from the table. | |
| virtual CoreExport void | DeleteThis () |
| Deletes this ActionItem. | |
| virtual CoreExport BOOL | GetButtonText (int cmdId, MSTR &buttonText) |
| Retrieves the text that will be used when the ActionItem is on a text button. | |
| virtual CoreExport BOOL | GetMenuText (int cmdId, MSTR &menuText) |
| Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). | |
| virtual CoreExport BOOL | GetDescriptionText (int cmdId, MSTR &descText) |
| Retrieves the text that is used for tool tips and menu help. | |
| virtual CoreExport BOOL | IsChecked (int cmdId) |
| Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state. | |
| virtual CoreExport BOOL | IsIndeterminate (int cmdId) |
| Returns TRUE if the menu item should be indeterminate | |
| virtual CoreExport BOOL | IsItemVisible (int cmdId) |
| Determines if an item is to be visible on a menu. | |
| virtual CoreExport BOOL | IsEnabled (int cmdId) |
| Determines if the operation is currently enabled and available. | |
| virtual CoreExport void | WritePersistentActionId (int cmdId, MSTR &outIdString) |
| Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files. | |
| virtual CoreExport int | ReadPersistentActionId (const MSTR &idString) |
| Converts an action table string id to the action items numeric id. | |
| __declspec (deprecated) virtual int ReadPersistentActionId(MSTR &idString) MAX_SEALED | |
| virtual CoreExport MaxIcon * | GetIcon (int cmdId) |
| Returns an optional icon for the command, or NULL if there is none. | |
| CoreExport void | BuildActionTable (HACCEL hDefaults, int numIds, ActionDescription *pOps, HINSTANCE hInst) |
| Fills the action table with the given action descriptions. | |
| virtual CoreExport ActionItem * | GetCurrentAssignment (ACCEL accel) |
| Gets the action assigned to the given accelerator, if any. | |
| virtual CoreExport void | AssignKey (int cmdId, ACCEL accel) |
| Assigns the command to the given accelerator. | |
| virtual CoreExport void | RemoveShortcutFromTable (ACCEL accel) |
| Removes the given assignment from the shortcut table. | |
| CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| CoreExport FPInterfaceDesc * | GetDesc () |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual CoreExport Interface_ID | GetID () |
Keyboard Accelerator Functions | |
| virtual CoreExport HACCEL | GetHAccel () |
| Returns the handle of the current keyboard accelerator for the table. | |
| virtual CoreExport void | SetHAccel (HACCEL hAccel) |
| Sets the current keyboard accelerator for the table. | |
| virtual CoreExport HACCEL | GetDefaultHAccel () |
| Gets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport void | SetDefaultHAccel (HACCEL accel) |
| Sets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport HACCEL | GetHAccel () |
| Returns the handle of the current keyboard accelerator for the table. | |
| virtual CoreExport void | SetHAccel (HACCEL hAccel) |
| Sets the current keyboard accelerator for the table. | |
| virtual CoreExport HACCEL | GetDefaultHAccel () |
| Gets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport void | SetDefaultHAccel (HACCEL accel) |
| Sets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport HACCEL | GetHAccel () |
| Returns the handle of the current keyboard accelerator for the table. | |
| virtual CoreExport void | SetHAccel (HACCEL hAccel) |
| Sets the current keyboard accelerator for the table. | |
| virtual CoreExport HACCEL | GetDefaultHAccel () |
| Gets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport void | SetDefaultHAccel (HACCEL accel) |
| Sets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport HACCEL | GetHAccel () |
| Returns the handle of the current keyboard accelerator for the table. | |
| virtual CoreExport void | SetHAccel (HACCEL hAccel) |
| Sets the current keyboard accelerator for the table. | |
| virtual CoreExport HACCEL | GetDefaultHAccel () |
| Gets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport void | SetDefaultHAccel (HACCEL accel) |
| Sets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport HACCEL | GetHAccel () |
| Returns the handle of the current keyboard accelerator for the table. | |
| virtual CoreExport void | SetHAccel (HACCEL hAccel) |
| Sets the current keyboard accelerator for the table. | |
| virtual CoreExport HACCEL | GetDefaultHAccel () |
| Gets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| virtual CoreExport void | SetDefaultHAccel (HACCEL accel) |
| Sets the default keyboard accelerator table used when the user has not assigned any accelerators. | |
| Public Member Functions inherited from FPMixinInterface | |
| FPMixinInterface () | |
| virtual LifetimeType | LifetimeControl () |
| virtual CoreExport bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| CoreExport | ~FPMixinInterface () |
| virtual BaseInterface * | GetInterface (Interface_ID id) |
| virtual FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| virtual Interface_ID | GetID () |
| Public Member Functions inherited from FPInterface | |
| virtual BaseInterface * | GetInterface (Interface_ID id) |
| virtual FPInterfaceDesc * | GetDesc ()=0 |
| virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL) |
| virtual FPStatus | Invoke (FunctionID fid, FPParams *params) |
| virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL) |
| virtual FPStatus | Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL) |
| virtual CoreExport FunctionID | FindFn (const MCHAR *name) |
| virtual CoreExport BOOL | IsEnabled (FunctionID actionID) |
| virtual CoreExport BOOL | IsChecked (FunctionID actionID) |
| virtual CoreExport BOOL | IsVisible (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsEnabled (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsChecked (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsVisible (FunctionID actionID) |
| virtual ActionTable * | GetActionTable () |
| virtual void | EnableActions (BOOL onOff) |
| Public Member Functions inherited from BaseInterface | |
| virtual UtilExport | ~BaseInterface () |
| Destructor. | |
| UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
| virtual UtilExport Interface_ID | GetID () |
| virtual LifetimeType | LifetimeControl () |
| virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual BaseInterface * | AcquireInterface () |
| virtual void | ReleaseInterface () |
| virtual void | DeleteInterface () |
| virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
| Public Member Functions inherited from InterfaceServer | |
| virtual UtilExport | ~InterfaceServer () |
| Destructor. | |
| virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
| template<class InterfaceType > | |
| InterfaceType * | GetTypedInterface () |
Protected Attributes | |
| Tab< ActionItem * > | mOps |
| std::unordered_map< int, ActionItem * > | mActionItemLookup |
| Protected Attributes inherited from FPMixinInterface | |
| Tab< InterfaceNotifyCallback * > * | interfaceNotifyCBs |
Additional Inherited Members | |
| Static Public Member Functions inherited from MaxHeapOperators | |
| static UtilExport void * | operator new (size_t size) |
| Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
| Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. | |
| static UtilExport void * | operator new (size_t size, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. | |
| static UtilExport void * | operator new (size_t size, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. | |
| static UtilExport void * | operator new[] (size_t size) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
| static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate arrays of objects. | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
| static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
| static UtilExport void | operator delete (void *ptr) |
| Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. | |
| static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
| static UtilExport void | operator delete (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. | |
| static UtilExport void | operator delete[] (void *ptr) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. | |
| static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
| static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| Placement new operator. | |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| Placement delete operator. | |
| static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
| Allocates memory on a specified alignment boundary. | |
| static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
| Reallocates memory on a specified alignment boundary. | |
| static UtilExport void | aligned_free (void *ptr) |
| Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
| Static Public Attributes inherited from FPInterface | |
| static CoreExport FPInterfaceDesc | nullInterface |
Detailed Description
A table of action items that can be used by plug-ins to export tables of action items that can be used by the UI to attach to keyboard shortcuts, assigned to toolbar buttons, and add to menus.
3ds Max's core code exports several ActionTables for built-in operations in 3ds Max. Plug-ins can also export their own action tables via methods available in ClassDesc.
Every ActionTable also has an ActionContextId associated with it. This ActionContextId can be shared with other tables. When assigning keyboard shortcuts to items in an ActionTable, tables that share a unique context id are forced to have unique shortcuts. Tables with different context ids can have overlapping keyboard shortcut assignments.
All methods of this class are implemented by the system. Note that this class may be sub-classed if required and that many functions can be overridden. See the topic Action System for details on sub-classing this class and ActionItem. For details on implementing an ActionTable please refer to the sample at /maxsdk/samples/modifiers/ffd.
- See also
- Class FPMixinInterface, Class ClassDesc, Structure ActionDescription, Class ActionItem, Class ActionCallback, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.
3ds Max's core code exports several ActionTables for built-in operations in 3ds Max. Plug-ins can also export their own action tables via methods available in ClassDesc.
Every ActionTable also has an ActionContextId associated with it. This ActionContextId can be shared with other tables. When assigning keyboard shortcuts to items in an ActionTable, tables that share a unique context id are forced to have unique shortcuts. Tables with different context ids can have overlapping keyboard shortcut assignments.
All methods of this class are implemented by the system. Note that this class may be sub-classed if required and that many functions can be overridden. See the topic Action System for details on sub-classing this class and ActionItem. For details on implementing an ActionTable please refer to the sample at /maxsdk/samples/modifiers/ffd. <<<<<<< HEAD
- Version
- 4.0
\sa Class FPMixinInterface, Class ClassDesc, Structure ActionDescription, Class ActionItem, Class ActionCallback, Class ActionContext, Class IActionManager, Class Interface.
- See also
- Class FPMixinInterface, Class ClassDesc, Structure ActionDescription, Class ActionItem, Class ActionCallback, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.
a406e112cf287e51abdbba7f88b8e4b91e0a64e7
3ds Max's core code exports several ActionTables for built-in operations in 3ds Max. Plug-ins can also export their own action tables via methods available in ClassDesc.
Every ActionTable also has an ActionContextId associated with it. This ActionContextId can be shared with other tables. When assigning keyboard shortcuts to items in an ActionTable, tables that share a unique context id are forced to have unique shortcuts. Tables with different context ids can have overlapping keyboard shortcut assignments.
All methods of this class are implemented by the system. Note that this class may be sub-classed if required and that many functions can be overridden. See the topic Action System for details on sub-classing this class and ActionItem. For details on implementing an ActionTable please refer to the sample at /maxsdk/samples/modifiers/ffd.
- Version
- 4.0
- See also
- Class FPMixinInterface, Class ClassDesc, Structure ActionDescription, Class ActionItem, Class ActionCallback, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class Interface.
3ds Max's core code exports several ActionTables for built-in operations in 3ds Max. Plug-ins can also export their own action tables via methods available in ClassDesc.
Every ActionTable also has an ActionContextId associated with it. This ActionContextId can be shared with other tables. When assigning keyboard shortcuts to items in an ActionTable, tables that share a unique context id are forced to have unique shortcuts. Tables with different context ids can have overlapping keyboard shortcut assignments.
All methods of this class are implemented by the system. Note that this class may be sub-classed if required and that many functions can be overridden. See the topic Action System for details on sub-classing this class and ActionItem. For details on implementing an ActionTable please refer to the sample at /maxsdk/samples/modifiers/ffd.
- Version
- 4.0
- See also
- Class FPMixinInterface, Class ClassDesc, Structure ActionDescription, Class ActionItem, Class ActionCallback, Class ActionContext, Class IActionManager, Class Interface.
Member Enumeration Documentation
◆ ActionTableFps [1/5]
| enum ActionTableFps |
◆ ActionTableFps [2/5]
| enum ActionTableFps |
◆ ActionTableFps [3/5]
| enum ActionTableFps |
◆ ActionTableFps [4/5]
| enum ActionTableFps |
◆ ActionTableFps [5/5]
| enum ActionTableFps |
Constructor & Destructor Documentation
◆ ActionTable() [1/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name, | ||
| HACCEL | hDefaults, | ||
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
This constructor builds the action table using an array of descriptors.
It takes the ID of the table, the context id, a name for the table, a windows accelerator table that gives default keyboard assignments for the operations, the number of items, the table of operation descriptions, and the instance of the module where the string resources in the table are stored. When the action table is constructed the action context ID must be registered with the system using the IActionManager::RegisterActionContext() method.
- Parameters
-
id A unique ID for the ActionTable. Every ActionTable has a unique 32-bit integer ID. For new tables exported by plug-ins, the developer should choose a random 32-bit integer. You can use one of the two DWORDS generated by the gencid.exe program as an ActionTableId. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable. hDefaults The handle of the a windows accelerator table that gives default keyboard assignments for the operations. numIds The number of items in the description array pOps Points to the array of the operator descriptors. hInst The handle to the instance of the module where the string resources in the array of operator descriptors are stored.
◆ ActionTable() [2/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name | ||
| ) |
This constructor builds a new empty action table with the given ID, context ID and name.
You then need to add ActionItems to the table separately using the AppendOperation() method.
- Parameters
-
id The unique ID for the ActionTable. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable.
◆ ~ActionTable() [1/5]
|
virtual |
Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use.
◆ ActionTable() [3/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name, | ||
| HACCEL | hDefaults, | ||
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
This constructor builds the action table using an array of descriptors.
It takes the ID of the table, the context id, a name for the table, a windows accelerator table that gives default keyboard assignments for the operations, the number of items, the table of operation descriptions, and the instance of the module where the string resources in the table are stored. When the action table is constructed the action context ID must be registered with the system using the IActionManager::RegisterActionContext() method.
- Parameters
-
id A unique ID for the ActionTable. Every ActionTable has a unique 32-bit integer ID. For new tables exported by plug-ins, the developer should choose a random 32-bit integer. You can use one of the two DWORDS generated by the gencid.exe program as an ActionTableId. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable. hDefaults The handle of the a windows accelerator table that gives default keyboard assignments for the operations. numIds The number of items in the description array pOps Points to the array of the operator descriptors. hInst The handle to the instance of the module where the string resources in the array of operator descriptors are stored.
◆ ActionTable() [4/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name | ||
| ) |
This constructor builds a new empty action table with the given ID, context ID and name.
You then need to add ActionItems to the table separately using the AppendOperation() method.
- Parameters
-
id The unique ID for the ActionTable. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable.
◆ ~ActionTable() [2/5]
|
virtual |
Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use.
◆ ActionTable() [5/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name, | ||
| HACCEL | hDefaults, | ||
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
This constructor builds the action table using an array of descriptors.
It takes the ID of the table, the context id, a name for the table, a windows accelerator table that gives default keyboard assignments for the operations, the number of items, the table of operation descriptions, and the instance of the module where the string resources in the table are stored. When the action table is constructed the action context ID must be registered with the system using the IActionManager::RegisterActionContext() method.
- Parameters
-
id A unique ID for the ActionTable. Every ActionTable has a unique 32-bit integer ID. For new tables exported by plug-ins, the developer should choose a random 32-bit integer. You can use one of the two DWORDS generated by the gencid.exe program as an ActionTableId. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable. hDefaults The handle of the a windows accelerator table that gives default keyboard assignments for the operations. numIds The number of items in the description array pOps Points to the array of the operator descriptors. hInst The handle to the instance of the module where the string resources in the array of operator descriptors are stored.
◆ ActionTable() [6/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name | ||
| ) |
This constructor builds a new empty action table with the given ID, context ID and name.
You then need to add ActionItems to the table separately using the AppendOperation() method.
- Parameters
-
id The unique ID for the ActionTable. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable.
◆ ~ActionTable() [3/5]
|
virtual |
Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use.
◆ ActionTable() [7/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name, | ||
| HACCEL | hDefaults, | ||
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
This constructor builds the action table using an array of descriptors.
It takes the ID of the table, the context id, a name for the table, a windows accelerator table that gives default keyboard assignments for the operations, the number of items, the table of operation descriptions, and the instance of the module where the string resources in the table are stored. When the action table is constructed the action context ID must be registered with the system using the IActionManager::RegisterActionContext() method.
- Parameters
-
id A unique ID for the ActionTable. Every ActionTable has a unique 32-bit integer ID. For new tables exported by plug-ins, the developer should choose a random 32-bit integer. You can use one of the two DWORDS generated by the gencid.exe program as an ActionTableId. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable. hDefaults The handle of the a windows accelerator table that gives default keyboard assignments for the operations. numIds The number of items in the description array pOps Points to the array of the operator descriptors. hInst The handle to the instance of the module where the string resources in the array of operator descriptors are stored.
◆ ActionTable() [8/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name | ||
| ) |
This constructor builds a new empty action table with the given ID, context ID and name.
You then need to add ActionItems to the table separately using the AppendOperation() method.
- Parameters
-
id The unique ID for the ActionTable. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable.
◆ ~ActionTable() [4/5]
|
virtual |
Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use.
◆ ActionTable() [9/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name, | ||
| HACCEL | hDefaults, | ||
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
This constructor builds the action table using an array of descriptors.
It takes the ID of the table, the context id, a name for the table, a windows accelerator table that gives default keyboard assignments for the operations, the number of items, the table of operation descriptions, and the instance of the module where the string resources in the table are stored. When the action table is constructed the action context ID must be registered with the system using the IActionManager::RegisterActionContext() method.
- Parameters
-
id A unique ID for the ActionTable. Every ActionTable has a unique 32-bit integer ID. For new tables exported by plug-ins, the developer should choose a random 32-bit integer. You can use one of the two DWORDS generated by the gencid.exe program as an ActionTableId. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable. hDefaults The handle of the a windows accelerator table that gives default keyboard assignments for the operations. numIds The number of items in the description array pOps Points to the array of the operator descriptors. hInst The handle to the instance of the module where the string resources in the array of operator descriptors are stored.
◆ ActionTable() [10/10]
| CoreExport ActionTable | ( | ActionTableId | id, |
| ActionContextId | contextId, | ||
| const MSTR & | name | ||
| ) |
This constructor builds a new empty action table with the given ID, context ID and name.
You then need to add ActionItems to the table separately using the AppendOperation() method.
- Parameters
-
id The unique ID for the ActionTable. contextId The ActionContextID associated with this table. Several tables may share the same ActionContextID. name The name for the ActionTable.
◆ ~ActionTable() [5/5]
|
virtual |
Deletes all the operations maintained by the table and deletes the keyboard accelerator table if in use.
Member Function Documentation
◆ GetHAccel() [1/5]
|
virtual |
Returns the handle of the current keyboard accelerator for the table.
◆ SetHAccel() [1/5]
|
virtual |
Sets the current keyboard accelerator for the table.
◆ GetDefaultHAccel() [1/5]
|
virtual |
Gets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ SetDefaultHAccel() [1/5]
|
virtual |
Sets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ GetName() [1/5]
|
virtual |
Returns the name of the action table.
◆ GetId() [1/5]
|
virtual |
Returns the ActionTableID.
◆ GetContextId() [1/5]
|
virtual |
Returns the ActionContextId.
◆ GetCallback() [1/5]
|
virtual |
Get the current callback associated with this table.
Returns NULL if the table is not active.
◆ SetCallback() [1/5]
|
virtual |
Sets the callback object used by this ActionTable.
- Parameters
-
pCallback Points to the callback to set.
◆ Count() [1/5]
|
virtual |
Returns the number of ActionItems in the table.
◆ operator[]() [1/5]
|
virtual |
Returns a pointer to the nth ActionItem.
- Parameters
-
i The zero based index in the list of ActionItems.
◆ GetAction() [1/5]
|
virtual |
Returns a pointer to the ActionItem associated with the command ID passed.
- Parameters
-
cmdId The command ID.
◆ GetActionByIndex() [1/5]
|
virtual |
Returns a pointer to the nth ActionItem using the same algorithm as the operator[].
- Parameters
-
index The zero based index of the action.
- Returns
- A pointer to the ActionItem
◆ AppendOperation() [1/5]
|
virtual |
Appends an ActionItem to the table.
- Parameters
-
pAction A pointer the ActionItem to append.
◆ DeleteOperation() [1/5]
|
virtual |
Removes an operation from the table.
- Parameters
-
pAction Points to the ActionItem to delete.
- Returns
- TRUE if the operation was deleted; FALSE if it could not be found and wasn't.
◆ DeleteThis() [1/5]
|
virtual |
Deletes this ActionItem.
- Default implementation:
- { delete this; }
◆ GetButtonText() [1/5]
|
virtual |
Retrieves the text that will be used when the ActionItem is on a text button.
- Parameters
-
cmdId The unique ID of the command whose button text is retrieved. [out] buttonText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ GetMenuText() [1/5]
|
virtual |
Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
This can be different from the button text.
- Parameters
-
cmdId The unique ID of the command whose menu text is retrieved. menuText Storage for the text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
- Default Implementation:
- { return GetButtonText(cmdId, menuText); }virtual CoreExport BOOL GetButtonText(int cmdId, MSTR &buttonText)Retrieves the text that will be used when the ActionItem is on a text button.
◆ GetDescriptionText() [1/5]
|
virtual |
Retrieves the text that is used for tool tips and menu help.
This is also the string that is displayed for the operation in all the lists in the customization dialogs.
- Parameters
-
cmdId The unique ID of the command whose description text is retrieved. descText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ IsChecked() [1/5]
|
virtual |
Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsIndeterminate() [1/5]
|
virtual |
Returns TRUE if the menu item should be indeterminate
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsItemVisible() [1/5]
|
virtual |
Determines if an item is to be visible on a menu.
Returns TRUE if visible; FALSE if not.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ IsEnabled() [1/5]
|
virtual |
Determines if the operation is currently enabled and available.
Returns TRUE if enabled; FALSE if disabled.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ WritePersistentActionId() [1/5]
|
virtual |
Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files.
The default implementation is to convert the integer action item ID directly to a string.
- Parameters
-
cmdId The unique command or action item ID. outIdString The string where the action item ID is written to.
◆ ReadPersistentActionId() [1/5]
|
virtual |
Converts an action table string id to the action items numeric id.
This method can be used to convert string based action item identifiers read from a .CUI or *.KBD file to a numeric identifier. It's default implementation expects the string passed in as argument to contain one number.
- Parameters
-
idString The action ID string.
- Returns
- Returns -1 if the id could not be converted.
◆ __declspec() [1/5]
|
inline |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2022 - re-implement with const MSTR& method signature
◆ GetIcon() [1/5]
|
virtual |
Returns an optional icon for the command, or NULL if there is none.
- Parameters
-
cmdId The unique ID of the command.
◆ BuildActionTable() [1/5]
| CoreExport void BuildActionTable | ( | HACCEL | hDefaults, |
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
Fills the action table with the given action descriptions.
- Parameters
-
hDefaults The handle of the a windows accelerator table that provides keyboard assignments for the operations. numIds The number of ID's to add to the action table. pOps The array of action descriptions to build the table from. hInst The handle to the instance of the module.
◆ GetCurrentAssignment() [1/5]
|
virtual |
Gets the action assigned to the given accelerator, if any.
- Parameters
-
accel The accelerator key you wish to check the assignment for.
◆ AssignKey() [1/5]
|
virtual |
Assigns the command to the given accelerator.
Also removes any previous assignment to that accelerator.
- Parameters
-
cmdId The command ID. accel The accelerator key you wish to assign.
◆ RemoveShortcutFromTable() [1/5]
|
virtual |
Removes the given assignment from the shortcut table.
- Parameters
-
accel The accelerator key you wish to remove from the shortcut table.
◆ GetDescByID() [1/5]
|
virtual |
- Remarks
- This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;
FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }
Then implement a GetDescByID() in the implementing class to avoid link export issues.
- Parameters:
- Interface_ID id
The unique interface ID by which to get the FPInterfaceDesc.
- Default Implementation:
- { return &nullInterface; }
Reimplemented from FPMixinInterface.
◆ GetDesc() [1/5]
|
virtual |
- Remarks
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
◆ GetInterface() [1/5]
|
virtual |
- Remarks
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
◆ GetID() [1/5]
|
virtual |
- Remarks
- This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
- Returns
- The Interface_ID.
- Default Implementation:
- { return GetDesc()->ID; }
Reimplemented from FPMixinInterface.
◆ RO_PROP_FN() [1/25]
|
protected |
◆ RO_PROP_FN() [2/25]
|
protected |
◆ RO_PROP_FN() [3/25]
|
protected |
◆ RO_PROP_FN() [4/25]
|
protected |
◆ RO_PROP_FN() [5/25]
|
protected |
◆ FN_1() [1/5]
|
protected |
◆ fpGetContextName() [1/5]
|
protected |
Used internally by Function Publishing.
◆ GetHAccel() [2/5]
|
virtual |
Returns the handle of the current keyboard accelerator for the table.
◆ SetHAccel() [2/5]
|
virtual |
Sets the current keyboard accelerator for the table.
◆ GetDefaultHAccel() [2/5]
|
virtual |
Gets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ SetDefaultHAccel() [2/5]
|
virtual |
Sets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ GetName() [2/5]
|
virtual |
Returns the name of the action table.
◆ GetId() [2/5]
|
virtual |
Returns the ActionTableID.
◆ GetContextId() [2/5]
|
virtual |
Returns the ActionContextId.
◆ GetCallback() [2/5]
|
virtual |
Get the current callback associated with this table.
Returns NULL if the table is not active.
◆ SetCallback() [2/5]
|
virtual |
Sets the callback object used by this ActionTable.
- Parameters
-
pCallback Points to the callback to set.
◆ Count() [2/5]
|
virtual |
Returns the number of ActionItems in the table.
◆ operator[]() [2/5]
|
virtual |
Returns a pointer to the nth ActionItem.
- Parameters
-
i The zero based index in the list of ActionItems.
◆ GetAction() [2/5]
|
virtual |
Returns a pointer to the ActionItem associated with the command ID passed.
- Parameters
-
cmdId The command ID.
◆ GetActionByIndex() [2/5]
|
virtual |
Returns a pointer to the nth ActionItem using the same algorithm as the operator[].
- Parameters
-
index The zero based index of the action.
- Returns
- A pointer to the ActionItem
◆ AppendOperation() [2/5]
|
virtual |
Appends an ActionItem to the table.
- Parameters
-
pAction A pointer the ActionItem to append.
◆ DeleteOperation() [2/5]
|
virtual |
Removes an operation from the table.
- Parameters
-
pAction Points to the ActionItem to delete.
- Returns
- TRUE if the operation was deleted; FALSE if it could not be found and wasn't.
◆ DeleteThis() [2/5]
|
virtual |
Deletes this ActionItem.
- Default implementation:
- { delete this; }
◆ GetButtonText() [2/5]
|
virtual |
Retrieves the text that will be used when the ActionItem is on a text button.
- Parameters
-
cmdId The unique ID of the command whose button text is retrieved. [out] buttonText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ GetMenuText() [2/5]
|
virtual |
Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
This can be different from the button text.
- Parameters
-
cmdId The unique ID of the command whose menu text is retrieved. menuText Storage for the text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
- Default Implementation:
- { return GetButtonText(cmdId, menuText); }
◆ GetDescriptionText() [2/5]
|
virtual |
Retrieves the text that is used for tool tips and menu help.
This is also the string that is displayed for the operation in all the lists in the customization dialogs.
- Parameters
-
cmdId The unique ID of the command whose description text is retrieved. descText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ IsChecked() [2/5]
|
virtual |
Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsIndeterminate() [2/5]
|
virtual |
Returns TRUE if the menu item should be indeterminate
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsItemVisible() [2/5]
|
virtual |
Determines if an item is to be visible on a menu.
Returns TRUE if visible; FALSE if not.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ IsEnabled() [2/5]
|
virtual |
Determines if the operation is currently enabled and available.
Returns TRUE if enabled; FALSE if disabled.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ WritePersistentActionId() [2/5]
|
virtual |
Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files.
The default implementation is to convert the integer action item ID directly to a string.
- Parameters
-
cmdId The unique command or action item ID. outIdString The string where the action item ID is written to.
◆ ReadPersistentActionId() [2/5]
|
virtual |
Converts an action table string id to the action items numeric id.
This method can be used to convert string based action item identifiers read from a .CUI or *.KBD file to a numeric identifier. It's default implementation expects the string passed in as argument to contain one number.
- Parameters
-
idString The action ID string.
- Returns
- Returns -1 if the id could not be converted.
◆ __declspec() [2/5]
|
inline |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2022 - re-implement with const MSTR& method signature
◆ GetIcon() [2/5]
|
virtual |
Returns an optional icon for the command, or NULL if there is none.
- Parameters
-
cmdId The unique ID of the command.
◆ BuildActionTable() [2/5]
| CoreExport void BuildActionTable | ( | HACCEL | hDefaults, |
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
Fills the action table with the given action descriptions.
- Parameters
-
hDefaults The handle of the a windows accelerator table that provides keyboard assignments for the operations. numIds The number of ID's to add to the action table. pOps The array of action descriptions to build the table from. hInst The handle to the instance of the module.
◆ GetCurrentAssignment() [2/5]
|
virtual |
Gets the action assigned to the given accelerator, if any.
- Parameters
-
accel The accelerator key you wish to check the assignment for.
◆ AssignKey() [2/5]
|
virtual |
Assigns the command to the given accelerator.
Also removes any previous assignment to that accelerator.
- Parameters
-
cmdId The command ID. accel The accelerator key you wish to assign.
◆ RemoveShortcutFromTable() [2/5]
|
virtual |
Removes the given assignment from the shortcut table.
- Parameters
-
accel The accelerator key you wish to remove from the shortcut table.
◆ GetDescByID() [2/5]
|
virtual |
- Remarks
- This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;
FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }
Then implement a GetDescByID() in the implementing class to avoid link export issues.
- Parameters:
- Interface_ID id
The unique interface ID by which to get the FPInterfaceDesc.
- Default Implementation:
- { return &nullInterface; }
Reimplemented from FPMixinInterface.
◆ GetDesc() [2/5]
|
virtual |
- Remarks
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
◆ GetInterface() [2/5]
|
virtual |
- Remarks
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
◆ GetID() [2/5]
|
virtual |
- Remarks
- This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
- Returns
- The Interface_ID.
- Default Implementation:
- { return GetDesc()->ID; }
Reimplemented from FPMixinInterface.
◆ RO_PROP_FN() [6/25]
|
protected |
◆ RO_PROP_FN() [7/25]
|
protected |
◆ RO_PROP_FN() [8/25]
|
protected |
◆ RO_PROP_FN() [9/25]
|
protected |
◆ RO_PROP_FN() [10/25]
|
protected |
◆ FN_1() [2/5]
|
protected |
◆ fpGetContextName() [2/5]
|
protected |
Used internally by Function Publishing.
◆ GetHAccel() [3/5]
|
virtual |
Returns the handle of the current keyboard accelerator for the table.
◆ SetHAccel() [3/5]
|
virtual |
Sets the current keyboard accelerator for the table.
◆ GetDefaultHAccel() [3/5]
|
virtual |
Gets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ SetDefaultHAccel() [3/5]
|
virtual |
Sets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ GetName() [3/5]
|
virtual |
Returns the name of the action table.
◆ GetId() [3/5]
|
virtual |
Returns the ActionTableID.
◆ GetContextId() [3/5]
|
virtual |
Returns the ActionContextId.
◆ GetCallback() [3/5]
|
virtual |
Get the current callback associated with this table.
Returns NULL if the table is not active.
◆ SetCallback() [3/5]
|
virtual |
Sets the callback object used by this ActionTable.
- Parameters
-
pCallback Points to the callback to set.
◆ Count() [3/5]
|
virtual |
Returns the number of ActionItems in the table.
◆ operator[]() [3/5]
|
virtual |
Returns a pointer to the nth ActionItem.
- Parameters
-
i The zero based index in the list of ActionItems.
◆ GetAction() [3/5]
|
virtual |
Returns a pointer to the ActionItem associated with the command ID passed.
- Parameters
-
cmdId The command ID.
◆ GetActionByIndex() [3/5]
|
virtual |
Returns a pointer to the nth ActionItem using the same algorithm as the operator[].
- Parameters
-
index The zero based index of the action.
- Returns
- A pointer to the ActionItem
◆ AppendOperation() [3/5]
|
virtual |
Appends an ActionItem to the table.
- Parameters
-
pAction A pointer the ActionItem to append.
◆ DeleteOperation() [3/5]
|
virtual |
Removes an operation from the table.
- Parameters
-
pAction Points to the ActionItem to delete.
- Returns
- TRUE if the operation was deleted; FALSE if it could not be found and wasn't.
◆ DeleteThis() [3/5]
|
virtual |
Deletes this ActionItem.
- Default implementation:
- { delete this; }
◆ GetButtonText() [3/5]
|
virtual |
Retrieves the text that will be used when the ActionItem is on a text button.
- Parameters
-
cmdId The unique ID of the command whose button text is retrieved. [out] buttonText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ GetMenuText() [3/5]
|
virtual |
Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
This can be different from the button text.
- Parameters
-
cmdId The unique ID of the command whose menu text is retrieved. menuText Storage for the text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
- Default Implementation:
- { return GetButtonText(cmdId, menuText); }
◆ GetDescriptionText() [3/5]
|
virtual |
Retrieves the text that is used for tool tips and menu help.
This is also the string that is displayed for the operation in all the lists in the customization dialogs.
- Parameters
-
cmdId The unique ID of the command whose description text is retrieved. descText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ IsChecked() [3/5]
|
virtual |
Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsIndeterminate() [3/5]
|
virtual |
Returns TRUE if the menu item should be indeterminate
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsItemVisible() [3/5]
|
virtual |
Determines if an item is to be visible on a menu.
Returns TRUE if visible; FALSE if not.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ IsEnabled() [3/5]
|
virtual |
Determines if the operation is currently enabled and available.
Returns TRUE if enabled; FALSE if disabled.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ WritePersistentActionId() [3/5]
|
virtual |
Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files.
The default implementation is to convert the integer action item ID directly to a string.
- Parameters
-
cmdId The unique command or action item ID. outIdString The string where the action item ID is written to.
◆ ReadPersistentActionId() [3/5]
|
virtual |
Converts an action table string id to the action items numeric id.
This method can be used to convert string based action item identifiers read from a .CUI or *.KBD file to a numeric identifier. It's default implementation expects the string passed in as argument to contain one number.
- Parameters
-
idString The action ID string.
- Returns
- Returns -1 if the id could not be converted.
◆ __declspec() [3/5]
|
inline |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2022 - re-implement with const MSTR& method signature
◆ GetIcon() [3/5]
|
virtual |
Returns an optional icon for the command, or NULL if there is none.
- Parameters
-
cmdId The unique ID of the command.
◆ BuildActionTable() [3/5]
| CoreExport void BuildActionTable | ( | HACCEL | hDefaults, |
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
Fills the action table with the given action descriptions.
- Parameters
-
hDefaults The handle of the a windows accelerator table that provides keyboard assignments for the operations. numIds The number of ID's to add to the action table. pOps The array of action descriptions to build the table from. hInst The handle to the instance of the module.
◆ GetCurrentAssignment() [3/5]
|
virtual |
Gets the action assigned to the given accelerator, if any.
- Parameters
-
accel The accelerator key you wish to check the assignment for.
◆ AssignKey() [3/5]
|
virtual |
Assigns the command to the given accelerator.
Also removes any previous assignment to that accelerator.
- Parameters
-
cmdId The command ID. accel The accelerator key you wish to assign.
◆ RemoveShortcutFromTable() [3/5]
|
virtual |
Removes the given assignment from the shortcut table.
- Parameters
-
accel The accelerator key you wish to remove from the shortcut table.
◆ GetDescByID() [3/5]
|
virtual |
- Remarks
- This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;
FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }
Then implement a GetDescByID() in the implementing class to avoid link export issues.
- Parameters:
- Interface_ID id
The unique interface ID by which to get the FPInterfaceDesc.
- Default Implementation:
- { return &nullInterface; }
Reimplemented from FPMixinInterface.
◆ GetDesc() [3/5]
|
virtual |
- Remarks
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
◆ GetInterface() [3/5]
|
virtual |
- Remarks
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
◆ GetID() [3/5]
|
virtual |
- Remarks
- This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
- Returns
- The Interface_ID.
- Default Implementation:
- { return GetDesc()->ID; }
Reimplemented from FPMixinInterface.
◆ RO_PROP_FN() [11/25]
|
protected |
◆ RO_PROP_FN() [12/25]
|
protected |
◆ RO_PROP_FN() [13/25]
|
protected |
◆ RO_PROP_FN() [14/25]
|
protected |
◆ RO_PROP_FN() [15/25]
|
protected |
◆ FN_1() [3/5]
|
protected |
◆ fpGetContextName() [3/5]
|
protected |
Used internally by Function Publishing.
◆ GetHAccel() [4/5]
|
virtual |
Returns the handle of the current keyboard accelerator for the table.
◆ SetHAccel() [4/5]
|
virtual |
Sets the current keyboard accelerator for the table.
◆ GetDefaultHAccel() [4/5]
|
virtual |
Gets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ SetDefaultHAccel() [4/5]
|
virtual |
Sets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ GetName() [4/5]
|
virtual |
Returns the name of the action table.
◆ GetId() [4/5]
|
virtual |
Returns the ActionTableID.
◆ GetContextId() [4/5]
|
virtual |
Returns the ActionContextId.
◆ GetCallback() [4/5]
|
virtual |
Get the current callback associated with this table.
Returns NULL if the table is not active.
◆ SetCallback() [4/5]
|
virtual |
Sets the callback object used by this ActionTable.
- Parameters
-
pCallback Points to the callback to set.
◆ Count() [4/5]
|
virtual |
Returns the number of ActionItems in the table.
◆ operator[]() [4/5]
|
virtual |
Returns a pointer to the nth ActionItem.
- Parameters
-
i The zero based index in the list of ActionItems.
◆ GetAction() [4/5]
|
virtual |
Returns a pointer to the ActionItem associated with the command ID passed.
- Parameters
-
cmdId The command ID.
◆ GetActionByIndex() [4/5]
|
virtual |
Returns a pointer to the nth ActionItem using the same algorithm as the operator[].
- Parameters
-
index The zero based index of the action.
- Returns
- A pointer to the ActionItem
◆ AppendOperation() [4/5]
|
virtual |
Appends an ActionItem to the table.
- Parameters
-
pAction A pointer the ActionItem to append.
◆ DeleteOperation() [4/5]
|
virtual |
Removes an operation from the table.
- Parameters
-
pAction Points to the ActionItem to delete.
- Returns
- TRUE if the operation was deleted; FALSE if it could not be found and wasn't.
◆ DeleteThis() [4/5]
|
virtual |
Deletes this ActionItem.
- Default implementation:
- { delete this; }
◆ GetButtonText() [4/5]
|
virtual |
Retrieves the text that will be used when the ActionItem is on a text button.
- Parameters
-
cmdId The unique ID of the command whose button text is retrieved. [out] buttonText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ GetMenuText() [4/5]
|
virtual |
Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
This can be different from the button text.
- Parameters
-
cmdId The unique ID of the command whose menu text is retrieved. menuText Storage for the text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
- Default Implementation:
- { return GetButtonText(cmdId, menuText); }
◆ GetDescriptionText() [4/5]
|
virtual |
Retrieves the text that is used for tool tips and menu help.
This is also the string that is displayed for the operation in all the lists in the customization dialogs.
- Parameters
-
cmdId The unique ID of the command whose description text is retrieved. descText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ IsChecked() [4/5]
|
virtual |
Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsIndeterminate() [4/5]
|
virtual |
Returns TRUE if the menu item should be indeterminate
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsItemVisible() [4/5]
|
virtual |
Determines if an item is to be visible on a menu.
Returns TRUE if visible; FALSE if not.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ IsEnabled() [4/5]
|
virtual |
Determines if the operation is currently enabled and available.
Returns TRUE if enabled; FALSE if disabled.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ WritePersistentActionId() [4/5]
|
virtual |
Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files.
The default implementation is to convert the integer action item ID directly to a string.
- Parameters
-
cmdId The unique command or action item ID. outIdString The string where the action item ID is written to.
◆ ReadPersistentActionId() [4/5]
|
virtual |
Converts an action table string id to the action items numeric id.
This method can be used to convert string based action item identifiers read from a .CUI or *.KBD file to a numeric identifier. It's default implementation expects the string passed in as argument to contain one number.
- Parameters
-
idString The action ID string.
- Returns
- Returns -1 if the id could not be converted.
◆ __declspec() [4/5]
|
inline |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2022 - re-implement with const MSTR& method signature
◆ GetIcon() [4/5]
|
virtual |
Returns an optional icon for the command, or NULL if there is none.
- Parameters
-
cmdId The unique ID of the command.
◆ BuildActionTable() [4/5]
| CoreExport void BuildActionTable | ( | HACCEL | hDefaults, |
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
Fills the action table with the given action descriptions.
- Parameters
-
hDefaults The handle of the a windows accelerator table that provides keyboard assignments for the operations. numIds The number of ID's to add to the action table. pOps The array of action descriptions to build the table from. hInst The handle to the instance of the module.
◆ GetCurrentAssignment() [4/5]
|
virtual |
Gets the action assigned to the given accelerator, if any.
- Parameters
-
accel The accelerator key you wish to check the assignment for.
◆ AssignKey() [4/5]
|
virtual |
Assigns the command to the given accelerator.
Also removes any previous assignment to that accelerator.
- Parameters
-
cmdId The command ID. accel The accelerator key you wish to assign.
◆ RemoveShortcutFromTable() [4/5]
|
virtual |
Removes the given assignment from the shortcut table.
- Parameters
-
accel The accelerator key you wish to remove from the shortcut table.
◆ GetDescByID() [4/5]
|
virtual |
- Remarks
- This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;
FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }
Then implement a GetDescByID() in the implementing class to avoid link export issues.
- Parameters:
- Interface_ID id
The unique interface ID by which to get the FPInterfaceDesc.
- Default Implementation:
- { return &nullInterface; }
Reimplemented from FPMixinInterface.
◆ GetDesc() [4/5]
|
virtual |
- Remarks
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
◆ GetInterface() [4/5]
|
virtual |
- Remarks
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
◆ GetID() [4/5]
|
virtual |
- Remarks
- This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
- Returns
- The Interface_ID.
- Default Implementation:
- { return GetDesc()->ID; }
Reimplemented from FPMixinInterface.
◆ RO_PROP_FN() [16/25]
|
protected |
◆ RO_PROP_FN() [17/25]
|
protected |
◆ RO_PROP_FN() [18/25]
|
protected |
◆ RO_PROP_FN() [19/25]
|
protected |
◆ RO_PROP_FN() [20/25]
|
protected |
◆ FN_1() [4/5]
|
protected |
◆ fpGetContextName() [4/5]
|
protected |
Used internally by Function Publishing.
◆ GetHAccel() [5/5]
|
virtual |
Returns the handle of the current keyboard accelerator for the table.
◆ SetHAccel() [5/5]
|
virtual |
Sets the current keyboard accelerator for the table.
◆ GetDefaultHAccel() [5/5]
|
virtual |
Gets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ SetDefaultHAccel() [5/5]
|
virtual |
Sets the default keyboard accelerator table used when the user has not assigned any accelerators.
◆ GetName() [5/5]
|
virtual |
Returns the name of the action table.
◆ GetId() [5/5]
|
virtual |
Returns the ActionTableID.
◆ GetContextId() [5/5]
|
virtual |
Returns the ActionContextId.
◆ GetCallback() [5/5]
|
virtual |
Get the current callback associated with this table.
Returns NULL if the table is not active.
◆ SetCallback() [5/5]
|
virtual |
Sets the callback object used by this ActionTable.
- Parameters
-
pCallback Points to the callback to set.
◆ Count() [5/5]
|
virtual |
Returns the number of ActionItems in the table.
◆ operator[]() [5/5]
|
virtual |
Returns a pointer to the nth ActionItem.
- Parameters
-
i The zero based index in the list of ActionItems.
◆ GetAction() [5/5]
|
virtual |
Returns a pointer to the ActionItem associated with the command ID passed.
- Parameters
-
cmdId The command ID.
◆ GetActionByIndex() [5/5]
|
virtual |
Returns a pointer to the nth ActionItem using the same algorithm as the operator[].
- Parameters
-
index The zero based index of the action.
- Returns
- A pointer to the ActionItem
◆ AppendOperation() [5/5]
|
virtual |
Appends an ActionItem to the table.
- Parameters
-
pAction A pointer the ActionItem to append.
◆ DeleteOperation() [5/5]
|
virtual |
Removes an operation from the table.
- Parameters
-
pAction Points to the ActionItem to delete.
- Returns
- TRUE if the operation was deleted; FALSE if it could not be found and wasn't.
◆ DeleteThis() [5/5]
|
virtual |
Deletes this ActionItem.
- Default implementation:
- { delete this; }
◆ GetButtonText() [5/5]
|
virtual |
Retrieves the text that will be used when the ActionItem is on a text button.
- Parameters
-
cmdId The unique ID of the command whose button text is retrieved. [out] buttonText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ GetMenuText() [5/5]
|
virtual |
Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
This can be different from the button text.
- Parameters
-
cmdId The unique ID of the command whose menu text is retrieved. menuText Storage for the text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
- Default Implementation:
- { return GetButtonText(cmdId, menuText); }
◆ GetDescriptionText() [5/5]
|
virtual |
Retrieves the text that is used for tool tips and menu help.
This is also the string that is displayed for the operation in all the lists in the customization dialogs.
- Parameters
-
cmdId The unique ID of the command whose description text is retrieved. descText The retrieved text.
- Returns
- TRUE if the command is in the table; otherwise FALSE.
◆ IsChecked() [5/5]
|
virtual |
Returns TRUE if the menu item should be checked or a CUI button should be in the pressed state.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsIndeterminate() [5/5]
|
virtual |
Returns TRUE if the menu item should be indeterminate
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return FALSE; }
◆ IsItemVisible() [5/5]
|
virtual |
Determines if an item is to be visible on a menu.
Returns TRUE if visible; FALSE if not.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ IsEnabled() [5/5]
|
virtual |
Determines if the operation is currently enabled and available.
Returns TRUE if enabled; FALSE if disabled.
- Parameters
-
cmdId The unique ID of the command.
- Default Implementation:
- { return TRUE; }
◆ WritePersistentActionId() [5/5]
|
virtual |
Converts an action item identifier to a string representation The textual representation of action item ids are used in .CUI and .KBD files.
The default implementation is to convert the integer action item ID directly to a string.
- Parameters
-
cmdId The unique command or action item ID. outIdString The string where the action item ID is written to.
◆ ReadPersistentActionId() [5/5]
|
virtual |
Converts an action table string id to the action items numeric id.
This method can be used to convert string based action item identifiers read from a .CUI or *.KBD file to a numeric identifier. It's default implementation expects the string passed in as argument to contain one number.
- Parameters
-
idString The action ID string.
- Returns
- Returns -1 if the id could not be converted.
◆ __declspec() [5/5]
|
inline |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2022 - re-implement with const MSTR& method signature
◆ GetIcon() [5/5]
|
virtual |
Returns an optional icon for the command, or NULL if there is none.
- Parameters
-
cmdId The unique ID of the command.
◆ BuildActionTable() [5/5]
| CoreExport void BuildActionTable | ( | HACCEL | hDefaults, |
| int | numIds, | ||
| ActionDescription * | pOps, | ||
| HINSTANCE | hInst | ||
| ) |
Fills the action table with the given action descriptions.
- Parameters
-
hDefaults The handle of the a windows accelerator table that provides keyboard assignments for the operations. numIds The number of ID's to add to the action table. pOps The array of action descriptions to build the table from. hInst The handle to the instance of the module.
◆ GetCurrentAssignment() [5/5]
|
virtual |
Gets the action assigned to the given accelerator, if any.
- Parameters
-
accel The accelerator key you wish to check the assignment for.
◆ AssignKey() [5/5]
|
virtual |
Assigns the command to the given accelerator.
Also removes any previous assignment to that accelerator.
- Parameters
-
cmdId The command ID. accel The accelerator key you wish to assign.
◆ RemoveShortcutFromTable() [5/5]
|
virtual |
Removes the given assignment from the shortcut table.
- Parameters
-
accel The accelerator key you wish to remove from the shortcut table.
◆ GetDescByID() [5/5]
|
virtual |
- Remarks
- This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;
FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }
Then implement a GetDescByID() in the implementing class to avoid link export issues.
- Parameters:
- Interface_ID id
The unique interface ID by which to get the FPInterfaceDesc.
- Default Implementation:
- { return &nullInterface; }
Reimplemented from FPMixinInterface.
◆ GetDesc() [5/5]
|
virtual |
- Remarks
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
◆ GetInterface() [5/5]
|
virtual |
- Remarks
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
◆ GetID() [5/5]
|
virtual |
- Remarks
- This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
- Returns
- The Interface_ID.
- Default Implementation:
- { return GetDesc()->ID; }
Reimplemented from FPMixinInterface.
◆ RO_PROP_FN() [21/25]
|
protected |
◆ RO_PROP_FN() [22/25]
|
protected |
◆ RO_PROP_FN() [23/25]
|
protected |
◆ RO_PROP_FN() [24/25]
|
protected |
◆ RO_PROP_FN() [25/25]
|
protected |
◆ FN_1() [5/5]
|
protected |
◆ fpGetContextName() [5/5]
|
protected |
Used internally by Function Publishing.
Member Data Documentation
◆ mOps
|
protected |
◆ mActionItemLookup
|
protected |
