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

#include <ILinkCmdSignalData.h>

Inheritance diagram for ILinkCmdSignalData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILINKCMDSIGNALDATA }
 

Public Member Functions

virtual void Set (ICommand *linkCmd, IDataBase *db, UIFlags uiflags=kFullUI)=0
 
virtual ICommandGetCommand () const =0
 
virtual IDataBaseGetDataBase () const =0
 
virtual const UIFlags GetUIFlags () const =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

ILinkCmdSignalData is the data sent with with the Link Command signals.

See Also
ISignalMgr
IResponder

Member Function Documentation

virtual ICommand* ILinkCmdSignalData::GetCommand () const
pure virtual

Get the link command for which this signal is being sent

Returns
the command.
virtual IDataBase* ILinkCmdSignalData::GetDataBase () const
pure virtual

Get the database this command is targeting

Returns
the database.
virtual const UIFlags ILinkCmdSignalData::GetUIFlags () const
pure virtual

Get the UI control flags

Returns
the UI control flags (kFullUI, kSuppressUI, kMinimalUI).
virtual void ILinkCmdSignalData::Set (ICommandlinkCmd,
IDataBasedb,
UIFlags uiflags = kFullUI 
)
pure virtual

Set the link command signal data.

Parameters
linkCmdIN the link command for which this signal is being sent
dbIN the database this command is targeting
uiflagsIN UI control flags (kFullUI, kSuppressUI, kMinimalUI)