#include <INewDocCmdData.h>

Inheritance diagram for INewDocCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWDOCCMDDATA }

Public Member Functions
virtual void	SetUIFlags (UIFlags uiflags)=0

virtual UIFlags	GetUIFlags () const =0

virtual void	SetCreateBasicDocument (uint16 typeFlags)=0

virtual uint16	GetCreateBasicDocument () const =0

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 void	SetUseUniformMargins (bool16 bUniform)=0

virtual bool16	GetUseUniformMargins () const =0

virtual void	SetColumns_4 (int32 numColumns, PMReal gutter, IColumns::ColumnOrientation direction)=0

virtual int32	GetNumColumns () const =0

virtual PMReal	GetGutter () const =0

virtual IColumns::ColumnOrientation	GetColumnOrientation_4 () const =0

virtual void	SetAutoTextFrame (bool16 shown)=0

virtual bool16	GetAutoTextFrame () const =0

virtual void	SetOverrideAutoTextFrame (bool16 bOverride)=0

virtual bool16	GetOverrideAutoTextFrame () const =0

virtual void	SetNewDocumentPageSize (const PMPageSize &pageSize)=0

virtual const PMPageSize &	GetNewDocumentPageSize () const =0

virtual void	SetSpreadScale (const K2Pair< PMReal, PMReal > &scale)=0

virtual PMReal	GetSpreadWidthScale () const =0

virtual PMReal	GetSpreadHeightScale () const =0

virtual void	SetWideOrientation (bool16 bWide)=0

virtual bool16	GetWideOrientation () const =0

virtual void	SetNumPages (int32 numPages)=0

virtual int32	GetNumPages () const =0

virtual void	SetPagesPerSpread (int32 numPagesPerSpread)=0

virtual int32	GetPagesPerSpread () const =0

virtual void	SetPageBinding (int32 bindingDirection)=0

virtual int32	GetPageBinding () const =0

virtual void	SetRestartPageNum (bool16 bRestartPageNum)=0

virtual bool16	GetRestartPageNum () const =0

virtual void	SetBleedBox (PMRect offsets)=0

virtual PMRect	GetBleedBox ()=0

virtual void	SetUseUniformBleed (bool16 bUniform)=0

virtual bool16	GetUseUniformBleed () const =0

virtual void	SetSlugBox (PMRect offsets)=0

virtual PMRect	GetSlugBox ()=0

virtual void	SetUseUniformSlug (bool16 bUniform)=0

virtual bool16	GetUseUniformSlug () const =0

virtual void	SetStartPageNumber (int32 startPageNumber)=0

virtual int32	GetStartPageNumber () const =0

virtual DocumentIntent	GetIntent () const =0

virtual void	SetIntent (DocumentIntent intent)=0

virtual void	SetDocBossClassID (ClassID bossID=kDocBoss)=0

virtual ClassID	GetDocBossClassID () const =0

virtual void	SetUndoSupport (IDocument::UndoSupport undoSupport)=0

virtual IDocument::UndoSupport	GetUndoSupport () 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 creating document or document styles related commands including kNewDocCmdBoss, kInCopyNewDocCmdBoss, kDocEditStyleCmdBoss, kSaveDocumentStyleDataCmdBoss

Member Enumeration Documentation

anonymous enum

Define the default IID for INewDocCmdData.

Member Function Documentation

virtual bool16 INewDocCmdData::GetAutoTextFrame ( ) const

pure virtual

Get the setting that determine if we need to create text frame on master page with the margin size when create a new document.

Returns: const bool16 kTrue indicating creating text frame on master page, otherwise kFalse.

virtual PMRect INewDocCmdData::GetBleedBox ( )

pure virtual

Get the bleed offsets.

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

virtual IColumns::ColumnOrientation INewDocCmdData::GetColumnOrientation_4 ( ) const

pure virtual

Get the direction of columns of the new document.

Returns: const bool16 kTrue is vertical column and kFalse is horizontal column.

virtual uint16 INewDocCmdData::GetCreateBasicDocument ( ) const

pure virtual

Get the type of the document being created.

Returns: uint16 indicating what kind of document being created. The type of document could be: 1) kFullNewDocument means standard document probably only meaningful by itself. 2) kMinimalNewDocument means minimal document formerly known as "Basic Document". 3) kXMLInterchangeNewDocument means XML interchange document which is a new document supported in InDesign 3.0.

virtual ClassID INewDocCmdData::GetDocBossClassID ( ) const

pure virtual

Return the value set in SetDocBossClassID.

Returns: boss id used to create document.

virtual PMReal INewDocCmdData::GetGutter ( ) const

pure virtual

Get the gutter value(the distance between two adjacent columns) of the new document.

Returns: const PMReal the gutter value.

virtual DocumentIntent INewDocCmdData::GetIntent ( ) const

pure virtual

Get the document intent preference

Parameters

void

Returns: DocumentIntent

virtual void INewDocCmdData::GetMargins	(	PMReal *	insideLeft,
		PMReal *	top,
		PMReal *	outsideRight,
		PMReal *	bottom
	)

pure virtual

Get the margins for the new document through the passed out parameters.

Parameters

insideLeft	refers to inside margin for facing pages case or left margin.
top	refers to top margin.
outsideRight	refers to outside margin for facing pages case or right margin.
bottom	refers to bottom margin

Returns: void.

virtual const PMPageSize& INewDocCmdData::GetNewDocumentPageSize ( ) const

pure virtual

Get the dimensions of the new page size.

Returns: const PMRect refers to the new page dimension.

virtual int32 INewDocCmdData::GetNumColumns ( ) const

pure virtual

Get the number of columns of the new document.

Returns: const int32 the number of columns.

virtual int32 INewDocCmdData::GetNumPages ( ) const

pure virtual

Get the number of pages the document will have.

Returns: const int32 the number of pages for the document.

virtual bool16 INewDocCmdData::GetOverrideAutoTextFrame ( ) const

pure virtual

Return if auto text frame should be overridden.

Returns: kTrue to override auto text frame (when it's on), kFalse for not.

virtual int32 INewDocCmdData::GetPageBinding ( ) const

pure virtual

Get the page binding setting.

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

virtual int32 INewDocCmdData::GetPagesPerSpread ( ) const

pure virtual

Get the number of pages each spread will have.

Returns: const int32 the number of pages for each spread.

virtual bool16 INewDocCmdData::GetRestartPageNum ( ) const

pure virtual

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

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

virtual PMRect INewDocCmdData::GetSlugBox ( )

pure virtual

Get the slug box offsets.

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

virtual PMReal INewDocCmdData::GetSpreadHeightScale ( ) const

pure virtual

Return the height scale to apply to the spread.

virtual PMReal INewDocCmdData::GetSpreadWidthScale ( ) const

pure virtual

Return the width scale to apply to the spread.

virtual int32 INewDocCmdData::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 UIFlags INewDocCmdData::GetUIFlags ( ) const

pure virtual

Get the UI settings when processing command.

Returns: UIFlags the UI setting when processing command.

virtual IDocument::UndoSupport INewDocCmdData::GetUndoSupport ( ) const

pure virtual

Get the undo support option

See Also: IDocument.

Returns: IDocument::UndoSupport.

virtual bool16 INewDocCmdData::GetUseUniformBleed ( ) const

pure virtual

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

Returns: bool16 kTrue indicating use uniform bleed, kFalse indicating not use uniform bleed.

virtual bool16 INewDocCmdData::GetUseUniformMargins ( ) const

pure virtual

Get the flag that determining if all margin values are set from the top value.

Returns: bool16 kTrue indicating all margin values should use the top value, otherwise set as kFalse.

virtual bool16 INewDocCmdData::GetUseUniformSlug ( ) const

pure virtual

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

Returns: bool16 kTrue indicating use uniform slug, kFalse indicating not use uniform slug.

virtual bool16 INewDocCmdData::GetWideOrientation ( ) const

pure virtual

Get the orientation of the document.

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

virtual void INewDocCmdData::SetAutoTextFrame ( bool16 shown )

pure virtual

Set the flag determining if you want to create text frame on master page with the margin size when create a new document.

Parameters

shown kTrue indicating creating text frame on master page, otherwise set as kFalse.

virtual void INewDocCmdData::SetBleedBox ( 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 INewDocCmdData::SetColumns_4	(	int32	numColumns,
		PMReal	gutter,
		IColumns::ColumnOrientation	direction
	)

pure virtual

Set the column attributes for the new document.

Parameters

numColumns	refers to the number of columns for the new document.
gutter	refers to distance between two adjacent columns.
direction	refers to column direction which is either horizontal or vertical. If direction is kTrue indicating vertical columns, otherwise, it is horizontal columns.

Returns: void.

virtual void INewDocCmdData::SetCreateBasicDocument ( uint16 typeFlags )

pure virtual

Set the type flag that what kind of document is being created.

Parameters

typeFlags refers to different types of document. The type of document could be: 1) kFullNewDocument means standard document probably only meaningful by itself. 2) kMinimalNewDocument means minimal document formerly known as "Basic Document". 3) kXMLInterchangeNewDocument means XML interchange document which is a new document supported in InDesign 3.0.

Returns: void.

virtual void INewDocCmdData::SetDocBossClassID ( ClassID bossID = kDocBoss )

pure virtual

Allow the setting of a custom document boss type other than kDocBoss.

Parameters

bossID id of boss to use.

Returns: void.

virtual void INewDocCmdData::SetIntent ( DocumentIntent intent )

pure virtual

Set the document intent preference

Parameters

intent IN - the new setting

virtual void INewDocCmdData::SetMargins	(	const PMReal &	insideLeft,
		const PMReal &	top,
		const PMReal &	outsideRight,
		const PMReal &	bottom
	)

pure virtual

Set the margins for the new document.

Parameters

insideLeft	refers to inside margin for facing pages case or left margin.
top	refers to top margin.
outsideRight	refers to outside margin for facing pages case or right margin.
bottom	refers to bottom margin

Returns: void.

virtual void INewDocCmdData::SetNewDocumentPageSize ( const PMPageSize & pageSize )

pure virtual

Set the dimensions of the new page size.

Parameters

pageSize refers to the new page size.

Returns: void.

virtual void INewDocCmdData::SetNumPages ( int32 numPages )

pure virtual

Set the number of pages the document will have.

Parameters

numPages refers to number of pages.

Returns: void.

virtual void INewDocCmdData::SetOverrideAutoTextFrame ( bool16 bOverride )

pure virtual

Set the flag determining if you want to create text frame on master page with the overrideable attribute. Only valid when GetAutoTextFrame is kTrue. Defaults to kTrue.

Parameters

bOverride indicating auto text frame on master page should be overridden or not.

virtual void INewDocCmdData::SetPageBinding ( int32 bindingDirection )

pure virtual

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

Parameters

bindingDirection refers to binding setting.

Returns: void.

virtual void INewDocCmdData::SetPagesPerSpread ( int32 numPagesPerSpread )

pure virtual

Set the number of pages each spread will have.

Parameters

numPagesPerSpread refers to the number of pages per spread.

Returns: void.

virtual void INewDocCmdData::SetRestartPageNum ( bool16 bRestartPageNum )

pure virtual

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

Parameters

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

Returns: void.

virtual void INewDocCmdData::SetSlugBox ( 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 INewDocCmdData::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 INewDocCmdData::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.

Returns: void.

virtual void INewDocCmdData::SetUIFlags ( UIFlags uiflags )

pure virtual

Set UI flags indicating if we need to bring up dialog when processing command.

Parameters

uiflags refers to UI setting such as kSuppressUI, kMinimalUI and kFullUI. UIFlags is defined in BaseType.h.

Returns: void.

virtual void INewDocCmdData::SetUndoSupport ( IDocument::UndoSupport undoSupport )

pure virtual

Set the undo support option

See Also: IDocument.

Parameters

IDocument::UndoSupport.

virtual void INewDocCmdData::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 INewDocCmdData::SetUseUniformMargins ( bool16 bUniform )

pure virtual

Set the flag determining if all margin values set from the top value.

Parameters

bUniform kTrue indicating all margin values should use the top value, otherwise set as kFalse.

Returns: void.

virtual void INewDocCmdData::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.

virtual void INewDocCmdData::SetWideOrientation ( 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.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation