SnpManipulateSpreadsAndPages Class Reference

Public Member Functions
	SnpManipulateSpreadsAndPages ()
virtual	~SnpManipulateSpreadsAndPages ()
ErrorCode	CreateSpreads (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	DuplicateSpreadContents (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	CreateSpreadFromSpread (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	DeleteSpread (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	MoveSpreads (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	CreatePages (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	DeletePages (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	MovePage (ISnpRunnableContext *iSnpRunnableContext)
ErrorCode	CreatePagesFromPages (ISnpRunnableContext *iSnpRunnableContext)

Detailed Description

• How to create spreads in a document.
• How to copy the contents of one spread onto another spread.
• How to create a new spread duplicated from an existing spread.
• How to delete an existing spread in the document.
• How to change the ordering of the spreads in a document.
• How to add new pages to an existing spread in the document.
• How to delete pages from an existing spread in the document.
• How to move a page to a different index within and across the spreads.
• How to clone pages (contents included) into new spreads int he document.

Constructor & Destructor Documentation

SnpManipulateSpreadsAndPages::SnpManipulateSpreadsAndPages ( )

inline

Constructor.

virtual SnpManipulateSpreadsAndPages::~SnpManipulateSpreadsAndPages ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpManipulateSpreadsAndPages::CreatePages

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Gathers the parameters required to drive the operation.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet compleses successfully.

ErrorCode SnpManipulateSpreadsAndPages::CreatePagesFromPages

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Determines how many pages to clone.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet completes successfully.

ErrorCode SnpManipulateSpreadsAndPages::CreateSpreadFromSpread

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Responsible for determining which spread should be the source for the copy command.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet compleses successfully.

ErrorCode SnpManipulateSpreadsAndPages::CreateSpreads

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Responsible for determining the parameters required to drive the lower level call.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet completes normally.

ErrorCode SnpManipulateSpreadsAndPages::DeletePages

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Determines how many pages to delete and whether shuffling should be performed.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet completes successfully.

ErrorCode SnpManipulateSpreadsAndPages::DeleteSpread

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Responsible for determining which spread is the target for the delete operation.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet compleses successfully.

ErrorCode SnpManipulateSpreadsAndPages::DuplicateSpreadContents

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Responsible for determining which spread should be duplicated and which spread it should be duplicated to.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet completes successfully.

ErrorCode SnpManipulateSpreadsAndPages::MovePage

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Determines which page gets moved, the target spread and the index in the target spread the page has to be moved to.

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet completes successfully.

ErrorCode SnpManipulateSpreadsAndPages::MoveSpreads

(

ISnpRunnableContext *

iSnpRunnableContext

)

The UI layer for this sub-snippet. Responsible for mapping the context to the spread list we wish to manipulate. This snippet moves the first spread to the end of the list (i.e. it becomes the last spread).

Parameters

iSnpRunnableContext

IN the environment.

Returns

kSuccess if the snippet compleses successfully.