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

#include <ICJKLayoutGridData.h>

Inheritance diagram for ICJKLayoutGridData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICJKLAYOUTGRIDDATA }
 
enum  GridStartingPoint {
  kTopOutside, kTopInside, kBottomOutside, kBottomInside,
  kCenterVertical, kCenterHorizontal, kCenter
}
 

Public Member Functions

virtual void SetGridStartingPoint (GridStartingPoint choice)=0
 
virtual GridStartingPoint GetGridStartingPoint ()=0
 
virtual void SetUseMaster (const bool16 useMaster)=0
 
virtual bool16 GetUseMaster ()=0
 
virtual void CopyFrom (ICJKLayoutGridData *source, bool16 doDirty=kTrue)=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

ICJKLayoutGridData is the interface for grid related data that is specific to the layout grid.

Member Function Documentation

virtual void ICJKLayoutGridData::CopyFrom (ICJKLayoutGridDatasource,
bool16 doDirty = kTrue 
)
pure virtual

CopyFrom copies from the source to this ICJKLayoutGridData.

Parameters
sourceIN The ICJKLayoutGridData to copy.
doDirtyIN Whether or not to dirty this ICJKLayoutGridData on copying.
virtual GridStartingPoint ICJKLayoutGridData::GetGridStartingPoint ()
pure virtual

GetGridStartingPoint

Returns
the grid starting point
virtual bool16 ICJKLayoutGridData::GetUseMaster ()
pure virtual

GetUseMaster

Returns
Whether or not this grid uses the master pages grid
virtual void ICJKLayoutGridData::SetGridStartingPoint (GridStartingPoint choice)
pure virtual

SetGridStartingPoint

Parameters
choiceIN The new grid starting point.
virtual void ICJKLayoutGridData::SetUseMaster (const bool16 useMaster)
pure virtual

SetUseMaster

Parameters
useMasterIN The new value for whether or not to use the master.