Represents an operation contained in an ActionTabls.
ActionItem is an abstract class with operations to support various UI operations. The system provides a default implementation of this class that works when the table is built with the ActionTable::BuildActionTable() method. However, developers may want to specialize this class for more special-purpose applications. For example, MAXScript does this to export macroScripts to an ActionTable. Methods that are marked as internal should not be used.
- Version
- 4.0
- See also
- Class ActionTable, Class ActionCallback, Structure ActionDescription, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class MAXIcon, Class Interface, class FPMixinInterface
|
| CoreExport | ActionItem () |
| | Constructor. More...
|
| |
| virtual CoreExport | ~ActionItem () |
| | Destructor. More...
|
| |
| virtual int | GetId ()=0 |
| | Retrieves a unique identifier for the action. More...
|
| |
| virtual BOOL | ExecuteAction ()=0 |
| | Executes the operation associated with the action item. More...
|
| |
| virtual CoreExport void | EmitMacro () |
| | Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action. More...
|
| |
| CoreExport BOOL | Execute () |
| | Calls ExecuteAction() and handles macro recording etc. More...
|
| |
| virtual void | GetButtonText (MSTR &buttonText)=0 |
| | Retrieves the text that will be used when the ActionItem is on a text button. More...
|
| |
| virtual void | GetMenuText (MSTR &menuText)=0 |
| | Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar). More...
|
| |
| virtual void | GetDescriptionText (MSTR &descText)=0 |
| | Retrieves the text that will be used for tool tips and menu help. More...
|
| |
| virtual void | GetCategoryText (MSTR &catText)=0 |
| | Retrieves the text for the category of the operation. More...
|
| |
| virtual BOOL | IsChecked ()=0 |
| | Returns whether a menu item is in a checked state, or if a button is in a pressed state. More...
|
| |
| virtual BOOL | IsIndeterminate () |
| | Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked. More...
|
| |
| virtual BOOL | IsItemVisible ()=0 |
| | Determines if an item is visible on a context menu. More...
|
| |
| virtual BOOL | IsEnabled ()=0 |
| | Determines if the operation is available to the user. More...
|
| |
| CoreExport MaxIcon * | GetIcon () |
| | Returns an icon associated with an ActionItem. More...
|
| |
| virtual void | DeleteThis ()=0 |
| | Called by 3ds Max to delete the ActionItem. More...
|
| |
| virtual CoreExport ActionTable * | GetTable () |
| | Returns a pointer to the table that owns the ActionItem. More...
|
| |
| virtual CoreExport void | SetTable (ActionTable *pTable) |
| | Sets the table that owns the item. More...
|
| |
| CoreExport const MCHAR * | GetShortcutString () |
| | Returns the string that describes all the keyboard shortcuts associated with the item. More...
|
| |
| virtual CoreExport MacroEntry * | GetMacroScript () |
| | Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise. More...
|
| |
| virtual CoreExport BOOL | IsDynamicMenu () |
| | Determines if a menu is created or if an action takes place. More...
|
| |
| virtual CoreExport void | SetIsDynamicMenu () |
| | This method may be called after an action item is created to tell the system that it is a dynamic menu action. More...
|
| |
| virtual CoreExport IMenu * | GetDynamicMenu (HWND hwnd, IPoint2 &m) |
| | If the ActionItem does produce a menu, this method is called to return a pointer to the menu. More...
|
| |
| virtual CoreExport BOOL | IsDynamicAction () |
| | ActionItems that are deleted after they execute should return TRUE. More...
|
| |
| CoreExport BOOL | HasIcon () |
| | Returns TRUE if the ActionItem specifies an icon. More...
|
| |
| CoreExport bool | GetIconFileName (MSTR &fileName) |
| | If the ActionItem specifies an icon, accesses the icon filename. More...
|
| |
| CoreExport int | GetIconIndex () |
| | If the ActionItem specifies an icon, returns the icon index. More...
|
| |
| CoreExport MSTR | GetTooltipKey () |
| | Get the Action's tooltip key. More...
|
| |
| CoreExport void | SetTooltipKey (const MCHAR *tooltipKey) |
| | Set the Action's tooltip key. More...
|
| |
| CoreExport MaxSDK::Util::Path | GetIconPath (IconSize size) |
| | Get the Action's path to the icon of size specified by param. More...
|
| |
| CoreExport void | SetIconPath (IconSize size, const MaxSDK::Util::Path &path) |
| | Sets the Action's path to the icon of size specified by the input param. More...
|
| |
| CoreExport MSTR | GetMetadata () |
| | Gets the Action's metadata. More...
|
| |
| CoreExport void | SetMetadata (const MCHAR *metadata) |
| | Sets the Action's metadata. More...
|
| |
| virtual CoreExport FPInterfaceDesc * | GetDescByID (Interface_ID id) |
| |
| virtual CoreExport FPInterfaceDesc * | GetDesc () |
| |
| virtual CoreExport BaseInterface * | GetInterface (Interface_ID id) |
| |
| virtual CoreExport Interface_ID | GetID () |
| |
| | FPMixinInterface () |
| |
| virtual LifetimeType | LifetimeControl () |
| |
| virtual CoreExport bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| |
| virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| |
| CoreExport | ~FPMixinInterface () |
| |
| 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) |
| |
| virtual UtilExport | ~BaseInterface () |
| | Destructor. More...
|
| |
| virtual BaseInterface * | AcquireInterface () |
| |
| virtual void | ReleaseInterface () |
| |
| virtual void | DeleteInterface () |
| |
| virtual BaseInterface * | CloneInterface (void *remapDir=NULL) |
| |
| virtual UtilExport | ~InterfaceServer () |
| | Destructor. More...
|
| |
|
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| | New operator used to allocate arrays of objects. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| | Placement new operator. More...
|
| |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| | Placement delete operator. More...
|
| |
| static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
| | Allocates memory on a specified alignment boundary. More...
|
| |
| static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
| | Reallocates memory on a specified alignment boundary. More...
|
| |
| static UtilExport void | aligned_free (void *ptr) |
| | Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
|
| |
| static CoreExport FPInterfaceDesc | nullInterface |
| |
Related help topics: 