IMenuItemExtension Class Referenceabstract
Extends the IMenuItem interface. More...
#include <imenus.h>
Inheritance diagram for IMenuItemExtension:
Public Member Functions | |
| virtual void | SetIconPath (const MSTR &iconPath)=0 |
| The path specified is relative to the icons for the current scheme, i.e. More... | |
| virtual const MSTR & | GetIconPath () const =0 |
| This returns the file path for the icon used by the menu item. More... | |
| Public Member Functions inherited from IMenuItem | |
| virtual void | SetIMenuLocalContext (IMenuLocalContext *pIMenuLocalContext)=0 |
| virtual ActionMode | GetActionMode () const =0 |
| virtual bool | ExecuteAction () const =0 |
| virtual void | ActAsSeparator ()=0 |
| virtual bool | IsSeparator () const =0 |
| virtual void | SetActionItem (ActionItem *pActionItem)=0 |
| virtual ActionItem * | GetActionItem () const =0 |
| virtual void | SetActionFn (ActionFn actionFn)=0 |
| virtual const ActionFn | GetActionFn () const =0 |
| virtual void | SetSubMenu (IMenu *menu)=0 |
| virtual IMenu * | GetSubMenu ()=0 |
| virtual void | SetPreDisplayCB (PreDisplayCB preDisplayCB)=0 |
| virtual const PreDisplayCB | GetPreDisplayCB () const =0 |
| virtual void | Display (bool leftToRight)=0 |
| virtual MCHAR | GetAccelerator ()=0 |
| virtual void | SetIcon (MaxIcon *pMaxIcon)=0 |
| virtual const MaxIcon * | GetIcon () const =0 |
| virtual void | SetChecked (bool checked)=0 |
| virtual bool | GetChecked ()=0 |
| virtual void | SetHighlighted (bool highlighted)=0 |
| virtual bool | GetHighlighted () const =0 |
| virtual void | SetUseCustomTitle (bool useCustomTitle)=0 |
| virtual bool | GetUseCustomTitle () const =0 |
| virtual void | SetDisplayFlat (bool displayFlat)=0 |
| virtual bool | GetDisplayFlat () const =0 |
| virtual void | PostMenuInteraction ()=0 |
| 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 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. More... | |
| 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. More... | |
| template<class InterfaceType > | |
| InterfaceType * | GetTypedInterface () |
| Public Member Functions inherited from IMenuElement | |
| virtual | ~IMenuElement () |
| virtual void | SetOrigin (const IPoint2 &origin, OriginLocation location)=0 |
| virtual const IPoint2 & | GetOrigin () const =0 |
| virtual void | SetVisible (bool visible)=0 |
| virtual bool | GetVisible ()=0 |
| virtual void | SetTitle (const MCHAR *customTitle)=0 |
| virtual const MSTR & | GetTitle ()=0 |
| virtual void | SetEnabled (bool enabled)=0 |
| virtual bool | GetEnabled ()=0 |
| virtual const IPoint2 & | GetSize ()=0 |
| virtual const Box2 & | GetRect ()=0 |
| virtual bool | IsInRect (const IPoint2 &point)=0 |
Additional Inherited Members | |
| Public Types inherited from IMenuItem | |
| enum | ActionMode { AM_INACTIVE = 0 , AM_SEPARATOR , AM_ITEM , AM_FN , AM_SUBMENU , AM_ITEM_SUBMENU } |
| enum | { setTitle , getTitle , setUseCustomTitle , getUseCustomTitle , setDisplayFlat , getDisplayFlat , getIsSeparator , getSubMenu , getMacroScript } |
| typedef int | IMenuItemIcon |
| typedef void(* | ActionFn) (void) |
| typedef void(* | PreDisplayCB) (IMenuItem &menuItem) |
| Public Types inherited from BaseInterface | |
| enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
| Public Types inherited from IMenuElement | |
| enum | OriginLocation { UPPER_LEFT , LOWER_LEFT , LOWER_RIGHT , UPPER_RIGHT } |
| 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. 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 Public Attributes inherited from FPInterface | |
| static CoreExport FPInterfaceDesc | nullInterface |
| Protected Member Functions inherited from FPMixinInterface | |
| FPMixinInterface (const FPMixinInterface &rhs) | |
| FPMixinInterface & | operator= (const FPMixinInterface &rhs) |
| Protected Member Functions inherited from FPInterface | |
| virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
| Protected Attributes inherited from FPMixinInterface | |
| Tab< InterfaceNotifyCallback * > * | interfaceNotifyCBs |
Detailed Description
Extends the IMenuItem interface.
This abstract class extends the IMenuItem interface. You can set a MaxIcon for a menu item, but this extension allows you to just specify the path to an image file, and let the menu item client deal with the generation of the icon
- See also
- Class IMenuItem
Member Function Documentation
◆ SetIconPath()
The path specified is relative to the icons for the current scheme, i.e.
relative to [executable]\UI_ln\Resources\[Light|Dark]\
◆ GetIconPath()
|
pure virtual |
This returns the file path for the icon used by the menu item.
