InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPageSetupPrefs Class Referenceabstract
Inheritance diagram for IPageSetupPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPAGEPREFERENCES }
 

Public Member Functions

virtual void SetPageSizePref (const PMPageSize &pageSize)=0
 
virtual PMPageSize GetPageSizePref () const =0
 
virtual void SetSpreadScale (const K2Pair< PMReal, PMReal > &scale)=0
 
virtual PMReal GetSpreadWidthScale () const =0
 
virtual PMReal GetSpreadHeightScale () const =0
 
virtual void SetWideOrientationPref (bool16 bWide)=0
 
virtual bool16 GetWideOrientationPref () const =0
 
virtual void SetNumPagesPref (int32 numPages)=0
 
virtual int32 GetNumPagesPref () const =0
 
virtual void SetStartPageNumber (int32 startPageNumber)=0
 
virtual int32 GetStartPageNumber () const =0
 
virtual void SetIntent (DocumentIntent intent)=0
 
virtual DocumentIntent GetIntent () const =0
 
virtual void SetPagesPerSpreadPref (int32 numPagesPerSpread)=0
 
virtual int32 GetPagesPerSpreadPref () const =0
 
virtual void SetAlwaysUsePagesPerSpreadPref (bool16 bAlways)=0
 
virtual bool16 GetAlwaysUsePagesPerSpreadPref () const =0
 
virtual void SetPageBindingPref (int32 pageBinding)=0
 
virtual int32 GetPageBindingPref () const =0
 
virtual void SetRestartPageNum (bool16 bRestart)=0
 
virtual bool16 GetRestartPageNum () const =0
 
virtual void SetBleedBoxPref (PMRect offsets)=0
 
virtual PMRect GetBleedBoxPref () const =0
 
virtual void SetUseUniformBleed (bool16 bUniform)=0
 
virtual bool16 GetUseUniformBleed () const =0
 
virtual void SetSlugBoxPref (PMRect offsets)=0
 
virtual PMRect GetSlugBoxPref () const =0
 
virtual void SetUseUniformSlug (bool16 bUniform)=0
 
virtual bool16 GetUseUniformSlug () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual PMRect IPageSetupPrefs::GetBleedBoxPref () const
pure virtual

Gets the bleed offsets.

Parameters
offsetsThe bleed offsets, stored in a rect. Inside offset stored in left, outside in right.
virtual DocumentIntent IPageSetupPrefs::GetIntent () const
pure virtual

Get the document intent preference

Parameters
void
Returns
DocumentIntent enum
virtual PMRect IPageSetupPrefs::GetSlugBoxPref () const
pure virtual

Gets the slug box offsets

Parameters
offsetsThe slug offsets, stored in a rect. Inside offset stored in left, outside in right.
virtual PMReal IPageSetupPrefs::GetSpreadHeightScale () const
pure virtual

Return the height scale to apply to the spread.

virtual PMReal IPageSetupPrefs::GetSpreadWidthScale () const
pure virtual

Return the width scale to apply to the spread.

virtual bool16 IPageSetupPrefs::GetUseUniformBleed () const
pure virtual

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

virtual bool16 IPageSetupPrefs::GetUseUniformSlug () const
pure virtual

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

virtual void IPageSetupPrefs::SetBleedBoxPref (PMRect offsets)
pure virtual

Sets the bleed offsets.

Parameters
offsetsThe bleed offsets, stored in a rect. Inside offset stored in left, outside in right.
virtual void IPageSetupPrefs::SetIntent (DocumentIntent intent)
pure virtual

Set the document intent preference

Parameters
intentIN - the new setting
virtual void IPageSetupPrefs::SetSlugBoxPref (PMRect offsets)
pure virtual

Sets the slug box offsets

Parameters
offsetsThe slug offsets, stored in a rect. Inside offset stored in left, outside in right.
virtual void IPageSetupPrefs::SetSpreadScale (const K2Pair< PMReal, PMReal > & scale)
pure virtual

Set the default scale to apply to new spreads. We typically apply scaling to spreads based on the ppi of the pages that will be in the spread.

Parameters
scale[IN] The x and y scale to apply to the spread.
virtual void IPageSetupPrefs::SetUseUniformBleed (bool16 bUniform)
pure virtual

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

Parameters
bUniformWhether to force all bleed values to be uniform, using Top value.
virtual void IPageSetupPrefs::SetUseUniformSlug (bool16 bUniform)
pure virtual

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

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