InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
kSnipRunGoButtonBoss Class Reference

#include <SdkObjModel.h>

Inheritance diagram for kSnipRunGoButtonBoss:
kRollOverIconButtonBosskIconSuiteButtonWidgetBosskBaseWidgetBoss

Public Member Functions

IPMUnknown IID_ISNIPRUNGOSELECTIONOBSERVER
 
IPMUnknown IID_ISNIPRUNSNIPPETNAMESTRINGDATA
 
IControlViewObservers IID_ICONTROLVIEWOBSERVERS
 
IPMUnknown IID_ISNIPRUNGOBUTTONOBSERVER
 
- Public Member Functions inherited from kRollOverIconButtonBoss
IPMUnknown IID_ICONTROLVIEW
 
IPNGIconAttributes IID_IPNGICONATTRIBUTES
 
IPMUnknown IID_IEVENTHANDLER
 
ITriStateControlData IID_ITRISTATECONTROLDATA
 
IMouseRollOver IID_IMOUSEROLLOVER
 
IPMUnknown IID_ICCKALTERNATEICONATTR
 
- Public Member Functions inherited from kIconSuiteButtonWidgetBoss
IBooleanControlData IID_IBOOLEANCONTROLDATA
 
ICursorRegion IID_ICURSORREGION
 
IPMUnknown IID_ITOGGLEATTRIBUTES
 
IPNGIconAttributes IID_IPNGICONATTRIBUTES
 
IPMUnknown IID_ICONTROLVIEW
 
ITriStateControlData IID_ITRISTATECONTROLDATA
 
- Public Member Functions inherited from kBaseWidgetBoss
IScript IID_ISCRIPT
 
IPMUnknown IID_IEVENTHANDLER
 
IPMUnknown IID_PERFORMKEYBOARDACCELERATOR
 
IPMUnknown IID_NEVERWRITESTODOCUMENT
 
IPMUnknown IID_ISCRIPTWIDGETTYPE
 
IDV_UI_NodeRef IID_IDV_UI_NODEREF
 
IPMUnknown IID_IDVEVENTHANDLER
 
IEveInfo IID_IEVEINFO
 
IWidgetParent IID_IWIDGETPARENT
 
IPMUnknown IID_IACCFIELDS
 
IPMUnknown IID_ICONTROLVIEW
 
IPMUnknown IID_ICACHEHINTS
 
IPMUnknown IID_ITIP
 
IPMPersist IID_IPMPERSIST
 
ISubject IID_ISUBJECT
 

Detailed Description

 Supports the Go button which gets enabled and disabled

dependent on whether the snippet can run or not. When the button is enabled a click on it will cause the selected snippet to be run via ISnipRunSuite. The name of the snippet this control works with is given by the IStringData interface aggregated using IID_ISNIPRUNSNIPPETNAMESTRINGDATA. To get this observer to recognise a change to this data client code should call this button's ISubject as shown below: ISubject::Change(kTextChangeStateMessage, IID_ISNIPRUNSNIPPETNAMESTRINGDATA);

Member Function Documentation

IControlViewObservers kSnipRunGoButtonBoss::IID_ICONTROLVIEWOBSERVERS
     IControlViewObservers attaches the button's observers,

implementation provided by the API.

    Implementation: kCControlViewObserversImpl.
IPMUnknown kSnipRunGoButtonBoss::IID_ISNIPRUNGOBUTTONOBSERVER

IObserver implementation provided by SnipRunGoButtonObserver.

Implementation: kSnipRunGoButtonObserverImpl.

IPMUnknown kSnipRunGoButtonBoss::IID_ISNIPRUNGOSELECTIONOBSERVER

IObserver implementation provided by SnipRunGoSelectionObserver.

Implementation: kSnipRunGoSelectionObserverImpl.

IPMUnknown kSnipRunGoButtonBoss::IID_ISNIPRUNSNIPPETNAMESTRINGDATA
     IStringData stores the name snippet the button operates on. This

is the name that is used passed to ISnipRunSuite. If the snippet cannot run the button is disabled by this control's observers.

    Implementation: kStringDataImpl.