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

#include <IMasterPage.h>

Inheritance diagram for IMasterPage:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMASTERPAGE }
 
enum  { kPositionDependant = kMaxUInt16 }
 

Public Member Functions

virtual UID GetMasterSpreadUID () const =0
 
virtual void SetMasterPageData (UID masterspreadUID, uint16 mpIndex=IMasterPage::kPositionDependant)=0
 
virtual uint16 GetMasterSpreadPageIndex (UID alternateMasterSpreadUID=kInvalidUID) const =0
 
virtual bool16 IsValid () const =0
 
virtual void SetMasterPageTransform (const PMMatrix &m)=0
 
virtual bool16 GetMasterPageTransform (PMMatrix *mp) 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

IMasterPage is an interface on a page boss (kPageBoss) which holds the UID of the IMasterSpread that is used for the particular page.

See Also
kPageBoss

Member Function Documentation

virtual uint16 IMasterPage::GetMasterSpreadPageIndex (UID alternateMasterSpreadUID = kInvalidUID) const
pure virtual

GetMasterSpreadPageIndex - get the index of the page on the master spread that this page has assigned to it.

Parameters
alternateMasterSpreadUID- if not kInvalidUID, GetMasterSpreadPageIndex returns the page index within some other master spread if that master were applied to this page.
Returns
uint16
virtual UID IMasterPage::GetMasterSpreadUID () const
pure virtual

GetMasterSpreadUID - get the UID of the spread that contains the master page assigned to this page.

Returns
UID - the UID of this page's master spread.
virtual bool16 IMasterPage::IsValid () const
pure virtual

IsValid - since anytime a page is queried for an IID_IMASTERPAGE interface, it will get some valid object back, this flag says if that is a 'valid' master (i.e. if it has been previously explicitly assigned to the page, instead of just created via QueryInterface

Returns
bool16
virtual void IMasterPage::SetMasterPageData (UID masterspreadUID,
uint16 mpIndex = IMasterPage::kPositionDependant 
)
pure virtual

SetMasterPageData - set the master spread and page index within that master spread associated with this page.

Parameters
mpUID- the UID of the SPREAD that contains the master assigned to the page.
mpIndex- historical, ignored