InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDynamicMenu Class Referenceabstract

#include <IDynamicMenu.h>

Inheritance diagram for IDynamicMenu:
IPMUnknownCPMUnknown< IDynamicMenu >DynMnuDynamicMenu

Public Types

enum  { kDefaultIID = IID_IDYNAMICMENU }
 

Public Member Functions

virtual void RebuildMenu (ActionID dynamicActionID, IPMUnknown *widget=nil)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Provide a mechanism for menu items to rebuild before being displayed. Typical response is to add/remove actions, and add/remove/rename menus.

See Also
IActionManager
IMenuManager

Member Function Documentation

virtual void IDynamicMenu::RebuildMenu (ActionID dynamicActionID,
IPMUnknownwidget = nil 
)
pure virtual

Rebuild a dynamic menu to add/remove/change its items.

Parameters
dynamicActionIDID of menu hit just before this method is called.
widgetcontains the widget that invoked this action. May be nil. e.g. Useful to use as a basis for Utils<IWidgetUtils>()->QueryRelatedWidget(...) to find widgets in a panel after its popup menu is hit. NB: Don't assume it's a widget from your panel (menu scripting may access any menu at any time).

Implemented in DynMnuDynamicMenu.