IDocSetupCmdData Class Reference

#include <IDocSetupCmdData.h>

Inheritance diagram for IDocSetupCmdData:

Public Member Functions
virtual void	SetDocSetupCmdData (const UIDRef &doc, const PMPageSize &newPageSize, int16 newNPages, int16 newNPagesPerSpread, bool16 bWide, int32 pageBinding, bool16 bRestartPageNum=kFalse)=0
virtual void	SetDocument (const UIDRef &doc)=0
virtual void	SetDocumentPageSize (const PMPageSize &newPageSize)=0
virtual void	SetNPages (const int16 newNPages)=0
virtual void	SetNPagesPerSpread (const int16 newNPagesPerSpread)=0
virtual void	SetPageOrientationIsWide (const bool16 bWide)=0
virtual void	SetPageBinding (const int32 pageBinding)=0
virtual void	SetRestartPageNum (const bool16 bRestartPageNum)=0
virtual void	SetBleedBox (const PMRect &offsets)=0
virtual void	SetUseUniformBleed (bool16 bUniform)=0
virtual void	SetSlugBox (const PMRect &offsets)=0
virtual void	SetUseUniformSlug (bool16 bUniform)=0
virtual void	SetStartPageNumber (int32 startPageNumber)=0
virtual void	SetIntent (DocumentIntent intent)=0
virtual const UIDRef &	GetDocument () const =0
virtual const PMPageSize &	GetDocumentPageSize () const =0
virtual const int16	GetNPages () const =0
virtual const int16	GetNPagesPerSpread () const =0
virtual const bool16	GetPageOrientationIsWide () const =0
virtual const int32	GetPageBinding () const =0
virtual const bool16	GetRestartPageNum () const =0
virtual const PMRect &	GetBleedBox () const =0
virtual const bool16	GetUseUniformBleed () const =0
virtual const PMRect &	GetSlugBox () const =0
virtual const bool16	GetUseUniformSlug () const =0
virtual const int32	GetStartPageNumber () const =0
virtual const DocumentIntent	GetIntent () const =0
virtual void	SetSpreadScale (const K2Pair< PMReal, PMReal > &scale)=0
virtual PMReal	GetSpreadWidthScale () const =0
virtual PMReal	GetSpreadHeightScale () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used to cache data for document set up related commands including kSetPageSizeCmdBoss, kSetPageSetupPrefsCmdBoss and kSetPageBindingCmdBoss.

Member Function Documentation

virtual const PMRect& IDocSetupCmdData::GetBleedBox ( ) const

pure virtual

Get the bleed offsets.

Returns

const PMRect the bleed offsets which is stored in a rect. Inside offset stored in left, outside offset stored in right.

virtual const UIDRef& IDocSetupCmdData::GetDocument ( ) const

pure virtual

Get the document which is affected.

Returns

const UIDRef the UIDRef of the document.

virtual const PMPageSize& IDocSetupCmdData::GetDocumentPageSize ( ) const

pure virtual

Get the dimensions of the new page size.

Returns

const PMRect refers to the new page dimension.

virtual const DocumentIntent IDocSetupCmdData::GetIntent ( ) const

pure virtual

Get the document intent preference

Parameters

void

Returns

DocumentIntent

See Also

IPageSetupPrefs.h, DocumentIntent enum

virtual const int16 IDocSetupCmdData::GetNPages ( ) const

pure virtual

Get the number of pages the document will have.

Returns

const int16 the number of pages for the document.

virtual const int16 IDocSetupCmdData::GetNPagesPerSpread ( ) const

pure virtual

Get the number of pages each spread will have.

Returns

const int16 the number of pages for each spread.

virtual const int32 IDocSetupCmdData::GetPageBinding ( ) const

pure virtual

Get the page binding setting.

Returns

const int32 indicating kDefaultBinding(-1), kLeftToRightBinding(0), kRightToLeftBinding(1).

virtual const bool16 IDocSetupCmdData::GetPageOrientationIsWide ( ) const

pure virtual

Get the orientation of the document.

Returns

const bool16 kTrue if the orientation is wide, kFalse if it is not.

virtual const bool16 IDocSetupCmdData::GetRestartPageNum ( ) const

pure virtual

Get the flag if page number needs to be restart or not.

Returns

const bool16 kTrue if page number needs to be restart, kFalse if it is not.

virtual const PMRect& IDocSetupCmdData::GetSlugBox ( ) const

pure virtual

Get the slug box offsets.

Returns

const PMRect the slug offsets which is stored in a rect. Inside offset stored in left, outside offset stored in right.

virtual PMReal IDocSetupCmdData::GetSpreadHeightScale ( ) const

pure virtual

Return the height scale to apply to the spread.

virtual PMReal IDocSetupCmdData::GetSpreadWidthScale ( ) const

pure virtual

Return the width scale to apply to the spread.

virtual const int32 IDocSetupCmdData::GetStartPageNumber ( ) const

pure virtual

Get the starting page number for the document.

Returns

const int32 the starting page number for the first page of the document.

virtual const bool16 IDocSetupCmdData::GetUseUniformBleed ( ) const

pure virtual

Check whether a change to any bleed value changes them all to that value.

Returns

const bool16 kTrue indicating use uniform bleed, kFalse indicating not use uniform bleed.

virtual const bool16 IDocSetupCmdData::GetUseUniformSlug ( ) const

pure virtual

Check whether a change to any slug value changes them all to that value.

Returns

const bool16 kTrue indicating use uniform slug, kFalse indicating not use uniform slug.

virtual void IDocSetupCmdData::SetBleedBox ( const PMRect &  offsets )

pure virtual

Set the bleed offsets.

Parameters

offsets

the bleed offsets which is stored in a rect. Inside offset stored in left, outside offset stored in right.

Returns

void.

virtual void IDocSetupCmdData::SetDocSetupCmdData ( const UIDRef &  doc, const PMPageSize &  newPageSize, int16  newNPages, int16  newNPagesPerSpread, bool16  bWide, int32  pageBinding, bool16  bRestartPageNum = kFalse  )

pure virtual

Set the document attributes.

Note: new bleed and slug parameters are NOT in Set function. Please see below.

Parameters

doc	refers to which document to affect.
newPageSize	refers to dimensions of the new page size.
newNPages	refers to how many pages should exist.
newNPagesPerSpread	refers to how many pages should be in each spread.
bWide	refers to the orientation of page in document.
pageBinding	refers to if pages read from right to left or left to right or something else. Currently page binding could be kDefaultBinding(-1), kLeftToRightBinding(0), kRightToLeftBinding(1).
bRestartPageNum	refers to if page number needs to be restart or not.

Returns

void.

virtual void IDocSetupCmdData::SetDocument ( const UIDRef &  doc )

pure virtual

Set the document which is affected.

Parameters

doc	refers to which document to affect.

Returns

void.

virtual void IDocSetupCmdData::SetDocumentPageSize ( const PMPageSize &  newPageSize )

pure virtual

Set the dimensions of the new page size.

Parameters

newPageSize

refers to the new page size.

Returns

void.

virtual void IDocSetupCmdData::SetIntent ( DocumentIntent  intent )

pure virtual

Set the document intent preference

Parameters

intent

IN - the new setting

See Also

IPageSetupPrefs.h

virtual void IDocSetupCmdData::SetNPages ( const int16  newNPages )

pure virtual

Set the number of pages the document will have.

Parameters

newNPages

refers to number of pages.

Returns

void.

virtual void IDocSetupCmdData::SetNPagesPerSpread ( const int16  newNPagesPerSpread )

pure virtual

Set the number of pages each spread will have.

Parameters

newNPagesPerSpread

refers to the number of pages per spread.

Returns

void.

virtual void IDocSetupCmdData::SetPageBinding ( const int32  pageBinding )

pure virtual

Set the binding of the pages in the document. Currently page binding could be kDefaultBinding(-1), kLeftToRightBinding(0), kRightToLeftBinding(1).

Parameters

pageBinding

refers to binding setting.

Returns

void.

virtual void IDocSetupCmdData::SetPageOrientationIsWide ( const bool16  bWide )

pure virtual

Set the orientation of the document.

Parameters

bWide

refers to if the document is wide or tall(kTrue if it is wide, kFalse if it is tall).

Returns

void.

virtual void IDocSetupCmdData::SetRestartPageNum ( const bool16  bRestartPageNum )

pure virtual

Set the flag determining if page number needs to be restart or not.

Parameters

bRestartPageNum

a flag determining if page number needs to be restart or not.

Returns

void.

virtual void IDocSetupCmdData::SetSlugBox ( const PMRect &  offsets )

pure virtual

Set the slug box offsets.

Parameters

offsets

refers to the slug offsets which is stored in a rect. Inside offset stored in left, outside offset stored in right.

Returns

void.

virtual void IDocSetupCmdData::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 IDocSetupCmdData::SetStartPageNumber ( int32  startPageNumber )

pure virtual

Set the starting page number for the document.

Parameters

startPageNumber

the number for the first page of the document. Defaults to -1 if not set by client, which means leave unchanged.

Returns

void.

virtual void IDocSetupCmdData::SetUseUniformBleed ( bool16  bUniform )

pure virtual

Tell whether a change to any bleed value change them all to that value.

Parameters

bUniform

is a flag determining a change to any bleed value change them all to that value.

Returns

void.

virtual void IDocSetupCmdData::SetUseUniformSlug ( bool16  bUniform )

pure virtual

Tell whether a change to any slug value changes them all to that value.

Parameters

bUniform

is a flag determining a change to any slug value changes them all to that value.

Returns

void.