IMenuManagerExtension Class Referenceabstract
Extension class for IMenuManager, can be accessed by calling GetCOREInterface()->GetMenuManager() and downcasting to this interface. More...
#include <imenuman.h>
Inheritance diagram for IMenuManagerExtension:
Public Member Functions | |
| virtual bool | IsMenuChangeNotificationEnabled () const =0 |
| Checks whether the notification NOTIFY_CUI_MENUS_UPDATED will be raised on changes to any menu. More... | |
| virtual void | SetMenuChangeNotificationEnabled (bool val)=0 |
| Controls whether the notification NOTIFY_CUI_MENUS_UPDATED will be raised on changes to any menu. More... | |
| virtual void | RaiseMenuChangeNotification ()=0 |
| Force raises the NOTIFY_CUI_MENUS_UPDATED notification to make interested parties aware of menu changes. More... | |
| Public Member Functions inherited from IMenuManager | |
| virtual bool | RegisterMenu (IMenu *pMenu, DWORD flags=0)=0 |
| virtual bool | UnRegisterMenu (IMenu *pMenu)=0 |
| This method allows you to remove a menu from the mananger. More... | |
| virtual IMenu * | FindMenu (const MCHAR *pTitle)=0 |
| This method will find a pointer to a menu based on its name. More... | |
| virtual IQuadMenu * | FindQuadMenu (const MCHAR *pTitle)=0 |
| This method will find a pointer to a quad menu based on its name. More... | |
| virtual bool | RegisterMenuBarContext (MenuContextId contextId, const MCHAR *pName)=0 |
| This method allows you to register a new menu bar context. More... | |
| virtual bool | RegisterQuadMenuContext (MenuContextId contextId, const MCHAR *pName)=0 |
| This method allows you to register a new quad menu context. More... | |
| virtual int | NumContexts ()=0 |
| virtual IMenuContext * | GetContextByIndex (int index)=0 |
| virtual IMenuContext * | GetContext (MenuContextId contextId)=0 |
| virtual void | UpdateMenuBar ()=0 |
| virtual BOOL | LoadMenuFile (const MCHAR *pMenuFile)=0 |
| virtual BOOL | SaveMenuFile (const MCHAR *pMenuFile)=0 |
| virtual const MCHAR * | GetMenuFile ()=0 |
| virtual BOOL | SetMainMenuBar (IMenu *pMenu)=0 |
| virtual BOOL | SetViewportRightClickMenu (IQuadMenuContext::RightClickContext context, IQuadMenu *pQuadMenu)=0 |
| virtual IQuadMenu * | GetViewportRightClickMenu (IQuadMenuContext::RightClickContext context)=0 |
| virtual IMenu * | GetMainMenuBar ()=0 |
| virtual bool | GetShowAllQuads (IQuadMenu *pQuadMenu)=0 |
| virtual void | SetShowAllQuads (IQuadMenu *pQuadMenu, bool showAll)=0 |
| virtual const MCHAR * | GetQuadMenuName (IQuadMenu *pQuadMenu)=0 |
| virtual void | SetQuadMenuName (IQuadMenu *pQuadMenu, const MCHAR *pName)=0 |
| Public Member Functions inherited from FPInterfaceDesc | |
| CoreExport | FPInterfaceDesc () |
| CoreExport | FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...) |
| CoreExport | ~FPInterfaceDesc () |
| virtual void | Init () |
| LifetimeType | LifetimeControl () |
| virtual BaseInterface * | GetInterface (Interface_ID id) |
| CoreExport void | LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...) |
| CoreExport void | AppendFunction (int id,...) |
| Add a new function to this interface descriptor. More... | |
| CoreExport void | AppendProperty (int id,...) |
| Add a new property to this interface descriptor. More... | |
| CoreExport void | AppendEnum (int id,...) |
| Add a new enum to this interface descriptor. More... | |
| CoreExport void | SetClassDesc (ClassDesc *i_cd) |
| CoreExport va_list | check_fn (va_list ap, int id) |
| CoreExport va_list | scan_fn (va_list ap, int id, int index) |
| CoreExport va_list | check_prop (va_list ap, int id) |
| CoreExport va_list | scan_prop (va_list ap, int id, int index) |
| CoreExport va_list | check_enum (va_list ap, EnumID id) |
| CoreExport va_list | scan_enum (va_list ap, EnumID id, int index) |
| FPInterfaceDesc * | GetDesc () |
| Interface_ID | GetID () |
| CoreExport FPFunctionDef * | GetFnDef (FunctionID fid) |
| ActionTable * | GetActionTable () |
| CoreExport void | EnableActions (BOOL onOff) |
| virtual CoreExport HINSTANCE | HInstance () |
| virtual CoreExport const MCHAR * | GetRsrcString (StringResID id) |
| Public Member Functions inherited from FPInterface | |
| 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) |
| Public Member Functions inherited from BaseInterface | |
| virtual UtilExport | ~BaseInterface () |
| Destructor. More... | |
| 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. More... | |
| template<class InterfaceType > | |
| InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
| Public Types inherited from IMenuManager | |
| enum | { loadMenuFile , saveMenuFile , getMenuFile , unRegisterMenu , unRegisterQuadMenu , registerMenuContext , findMenu , findQuadMenu , updateMenuBar , createQuadMenu , createMenu , createSubMenuItem , createSeparatorItem , createActionItem , setViewportRightClickMenu , getViewportRightClickMenu , getMainMenuBar , setMainMenuBar , getShowAllQuads , setShowAllQuads , numMenus , getMenu , numQuadMenus , getQuadMenu , getQuadMenuName , setQuadMenuName , createMenuItemFromAction } |
| Function Publishing IDs More... | |
| enum | { rightClickContext } |
| Public Types inherited from BaseInterface | |
| enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
| 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... | |
| Public Attributes inherited from FPInterfaceDesc | |
| Interface_ID | ID |
| MSTR | internal_name |
| StringResID | description |
| ClassDesc * | cd |
| USHORT | flags |
| Tab< FPFunctionDef * > | functions |
| Tab< FPPropDef * > | props |
| Tab< FPEnum * > | enumerations |
| MSPluginClass * | pc |
| Rollout * | rollout |
| ActionTable * | action_table |
| Static Public Attributes inherited from FPInterface | |
| static CoreExport FPInterfaceDesc | nullInterface |
| Protected Member Functions inherited from FPInterfaceDesc | |
| CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
| Protected Member Functions inherited from FPInterface | |
| virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
Detailed Description
Extension class for IMenuManager, can be accessed by calling GetCOREInterface()->GetMenuManager() and downcasting to this interface.
Member Function Documentation
◆ IsMenuChangeNotificationEnabled()
|
pure virtual |
Checks whether the notification NOTIFY_CUI_MENUS_UPDATED will be raised on changes to any menu.
- Returns
- true if the manager is currently raising notifications on menu changes
◆ SetMenuChangeNotificationEnabled()
|
pure virtual |
Controls whether the notification NOTIFY_CUI_MENUS_UPDATED will be raised on changes to any menu.
- Parameters
-
[in] val - either enables or disables notifications, can be used to do a batch menu change
◆ RaiseMenuChangeNotification()
|
pure virtual |
Force raises the NOTIFY_CUI_MENUS_UPDATED notification to make interested parties aware of menu changes.
Can be used at the end of a batch of changes to signal the end of the mass change.
