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

#include <IMoveColumnGuideCmdData.h>

Inheritance diagram for IMoveColumnGuideCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const UIDRef &pageUIDRef, const int32 columnIndex, const PMReal &columnLocation)=0
 
virtual const UIDRefGetPageUIDRef () const =0
 
virtual const int32 GetColumnIndex ()=0
 
virtual const PMRealGetColumnLocation () 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

Data interface for move column guide command.

See Also
kMoveColumnGuideCmdBoss

Member Function Documentation

virtual const int32 IMoveColumnGuideCmdData::GetColumnIndex ()
pure virtual

Return the column index value from the data interface.

Returns
int32 the column index.
virtual const PMReal& IMoveColumnGuideCmdData::GetColumnLocation () const
pure virtual

Return the column location value from the data interface.

Returns
PMReal& the location value (in points).
virtual const UIDRef& IMoveColumnGuideCmdData::GetPageUIDRef () const
pure virtual

Return the targetted page value from the data interface.

Returns
UIDRef& a const reference to the targetted page.
virtual void IMoveColumnGuideCmdData::Set (const UIDRefpageUIDRef,
const int32 columnIndex,
const PMRealcolumnLocation 
)
pure virtual

Set the new location value for the indicated column guide on the specified page. Automatically adjusts the neighboring column guide (except for first and last column guide on a page, in which case it isn't necessary).

Parameters
pageUIDRefIN UIDRef& a UIDRef for the page that is targetted..
columnIndexIN int32 the index of the column to change.
columnLocationIN PMReal& the value to use (in points). Relative to left margin (or top of page for J columns).