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

#include <IMarginPrefs.h>

Inheritance diagram for IMarginPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMARGINPREFERENCES }
 

Public Member Functions

virtual void SetMargins (const PMReal &insideLeft, const PMReal &top, const PMReal &outsideRight, const PMReal &bottom)=0
 
virtual void GetMargins (PMReal *insideLeft, PMReal *top, PMReal *outsideRight, PMReal *bottom)=0
 
virtual int32 GetColorIndex_DURING_CONVERSION_ONLY ()=0
 
virtual void SetColor (const UID uiColorUID)=0
 
virtual UIDRef GetColor ()=0
 
virtual void SetUseUniformMargins (bool16 bUniform)=0
 
virtual bool16 GetUseUniformMargins ()=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

Abstract interface to margin preferences. This interface exists on both the session and document workspace.

See Also
kPageBoss
kSetMarginPrefsCmdBoss

Member Function Documentation

virtual UIDRef IMarginPrefs::GetColor ()
pure virtual

Return the color to use for drawing margin lines.

Returns
the UIDRef of the color from IID_IUICOLORLIST.
See Also
IUIColorUtils.h
virtual int32 IMarginPrefs::GetColorIndex_DURING_CONVERSION_ONLY ()
pure virtual

Get the UI color index for the margins. DO NOT USE, used for conversion only.

Returns
int32 index of the color in the IID_IUICOLORLIST.
virtual bool16 IMarginPrefs::GetUseUniformMargins ()
pure virtual

Tells whether all margin values are set from one value (top).

virtual void IMarginPrefs::SetColor (const UID uiColorUID)
pure virtual

Set the UI color by UID for the margins.

Parameters
uiColorUIDthe UID of the UI color to use for drawing the margin lines.
See Also
IUIColorUtils.h
virtual void IMarginPrefs::SetMargins (const PMRealinsideLeft,
const PMRealtop,
const PMRealoutsideRight,
const PMRealbottom 
)
pure virtual

Set the margins for default pages and new documents.

Parameters
insideLeftrefers to inside (for facing pages case) or left margin.
toprefers to top margin.
outsideRightrefers to outside (for facing pages case) or right margin.
bottomrefers to bottom margin.
virtual void IMarginPrefs::SetUseUniformMargins (bool16 bUniform)
pure virtual

Tells that all margin values set from one value (top).

Parameters
bUniformWhether to force all margin values to be uniform, using Top value.