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

#include <ILayoutCmdData.h>

Inheritance diagram for ILayoutCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILAYOUTCMDDATA }
 

Public Member Functions

virtual void Set (const UIDRef &doc, ILayoutControlData *layoutData)=0
 
virtual ILayoutControlDataGetLayoutControlData ()=0
 
virtual const UIDRefGetDocument () 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

Command data interface used to pass layout data information to various commands

Member Function Documentation

virtual const UIDRef& ILayoutCmdData::GetDocument () const
pure virtual

Get document UIDRef

Parameters
none
Returns
const UIDRef of the document
virtual ILayoutControlData* ILayoutCmdData::GetLayoutControlData ()
pure virtual

Get layout control data

Parameters
none
Returns
ILayoutControlData. Usually used in commands to fetch layoutcontroldata
virtual void ILayoutCmdData::Set (const UIDRefdoc,
ILayoutControlDatalayoutData 
)
pure virtual

Set command data

Parameters
docUIDRef of the document the command will change
*layoutDataLayoutControlData pointer that passed into the command could be nil if the command don't need layout data (for example: used in scripting)