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

#include <IMasterOverrideable.h>

Inheritance diagram for IMasterOverrideable:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMASTEROVERRIDEABLE }
 
enum  MasterOverrideableType { kMasterOverrideable = 0x00, kMasterNotOverrideable = 0x01 }
 

Public Member Functions

virtual void Set (int32 masterOverrideableFlag)=0
 
virtual int32 GetMasterOverrideable () const =0
 
virtual bool16 IsMasterOverrideable () const =0
 
virtual bool16 IsMasterNotOverrideable () 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

Page item interface that controls if any item can be overrideable or not.

Member Function Documentation

virtual int32 IMasterOverrideable::GetMasterOverrideable () const
pure virtual

Return the master overrideable flag. In general, returns kMasterOverrideable or kMasterNotOverrideable based on the setting. However, for managed frames, additional logic comes into play. A content item is considered not overrideable whenever its parent frame is not overrideable.

Returns
bool16 Returns kMasterOverrideable or kMasterNotOverrideable
virtual bool16 IMasterOverrideable::IsMasterNotOverrideable () const
pure virtual

Return kTrue if the master page item is not overrideable.

Returns
bool16 Returns kTrue if GetMasterOverrideable returns kMasterNotOverrideable, kFalse otherwise.
virtual bool16 IMasterOverrideable::IsMasterOverrideable () const
pure virtual

Return kTrue if the master page item is overrideable.

Returns
bool16 Returns kTrue if GetMasterOverrideable returns kMasterOverrideable, kFalse otherwise.
virtual void IMasterOverrideable::Set (int32 masterOverrideableFlag)
pure virtual

Set the master overrideable flag See kSetMasterOverrideableCmdBoss for more info.

Parameters
int32- must be kMasterOverrideable or kMasterNotOverrideable.