Inheritance diagram for Facade::IFlowFacade:

Public Types
enum	{ kDefaultIID = IID_IFLOWFACADE }

Public Member Functions
virtual UIDRef	GetStoryFromSpline (const UIDRef &splineFlowFrameRef) const =0

virtual bool16	CanSetPrimaryTextFlowSpline (const UIDRef &masterSpreadRef, const UIDRef &splineFlowFrameRef) const =0

virtual bool16	CanSetPrimaryTextFlowStory (const UIDRef &masterSpreadRef, const UIDRef &storyRef) const =0

virtual ErrorCode	SetPrimaryTextFlowSpline (const UIDRef &masterSpreadRef, const UIDRef &splineFlowFrameRef)=0

virtual UIDRef	GetPrimaryTextFlowStory (const UIDRef &masterSpreadRef, const bool16 bWalkUpMasters=kFalse) const =0

virtual ErrorCode	SetPrimaryTextFlowStory (const UIDRef &masterSpreadRef, const UIDRef &storyRef)=0

virtual UIDList	GetPrimaryTextFlowSplineListForPage (const UIDRef &pageRef, const UIDRef &masterRef)=0

virtual UIDList	GetPrimaryTextFlowSplineListForMaster (const UIDRef &pageOrSpreadMasterRef)=0

virtual bool16	IsInPrimaryTextFlowStory (const UIDRef &masterRef, const UIDRef &splineRef) const =0

virtual bool16	IsAPrimaryTextFlowStory (const UIDRef &storyRef, UIDRef *fromThisMaster=nil) const =0

virtual bool16	IsAnOverriddenPrimaryTextFlowStory (const UIDRef &storyRef, UIDRef *fromThisMaster=nil) const =0

virtual bool16	CanCreateAlternateLayout (const UIDList &spreadList) const =0

virtual ErrorCode	CreateAlternateLayout (const UIDList &spreadList, const PMString &name, const PMPageSize &pageSize, const bool16 bCreateTextStyles, const bool16 bLinkTextStories, ILayoutObject::LayoutPolicy policy)=0

virtual bool16	CanDeleteAlternateLayout (const UIDRef &spreadRef) const =0

virtual ErrorCode	DeleteAlternateLayout (const UIDRef &spreadRef, bool16 bDeleteMasters=kTrue, bool16 bDeleteStyleGroups=kTrue)=0

virtual ErrorCode	DeletePrimaryTextFlowStory (const UIDRef &storyRef)=0

virtual ErrorCode	SetConstraints (const UIDList &itemList, const Flow::ConstraintList &list)=0

virtual void	GetConstraints (const UIDRef &oneItem, Flow::ConstraintList &outList) const =0

virtual bool16	GetDuringCreateAlternateLayout (IDocument *document) const =0

virtual void	SetDuringCreateAlternateLayout (IDocument *document, const bool16 flag)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual bool16 Facade::IFlowFacade::CanCreateAlternateLayout ( const UIDList & spreadList ) const

pure virtual

Can the list of spreads be used to create an alternate layout?

Parameters

spreadList - the list of spreads to use for the alternate layout

Returns: bool16 - kTrue or kFalse

virtual bool16 Facade::IFlowFacade::CanDeleteAlternateLayout ( const UIDRef & spreadRef ) const

pure virtual

Can the alternate layout containing the given spread be deleted?

Parameters

spreadRef - a UIDRef to a spread

Returns: bool16 - kTrue or kFalse

virtual bool16 Facade::IFlowFacade::CanSetPrimaryTextFlowSpline	(	const UIDRef &	masterSpreadRef,
		const UIDRef &	splineFlowFrameRef
	)		const

pure virtual

Can the indicated spline's story be set as the primary text flow for the master spread?

Parameters

masterRef	- the master spread target to set the flow
splineFlowFrameRef	- the spline (containing a MultiColumnTextFrame) whose story will be the primary text flow

Returns: bool16 - kTrue or kFalse

virtual bool16 Facade::IFlowFacade::CanSetPrimaryTextFlowStory	(	const UIDRef &	masterSpreadRef,
		const UIDRef &	storyRef
	)		const

pure virtual

Can the indicated story be set as the primary text flow for the master spread?

Parameters

masterRef	- the master spread target to set the flow
storyRef	- the story that will be the primary text flow

Returns: bool16 - kTrue or kFalse

virtual ErrorCode Facade::IFlowFacade::CreateAlternateLayout	(	const UIDList &	spreadList,
		const PMString &	name,
		const PMPageSize &	pageSize,
		const bool16	bCreateTextStyles,
		const bool16	bLinkTextStories,
		ILayoutObject::LayoutPolicy	policy
	)

pure virtual

Create an alternate layout for the document based on a set of spreads. All the spreads will be duplicated.

Parameters

spreadList	- the list of spreads to generate the new alternate layout of spreads from
name	- the name of the alternate layout.
pageSize	- the page size to use for the new spreads
bCreateTextStyles	- kTrue to create new text styles, kFalse otherwise
bLinkTextStories	- kTrue to create link text stories to source spreads, kFalse otherwise
policy	- the layout policy to use for the new pages. Do not use ILayoutObject::kUseMasterLayoutPolicy, use ILayoutObject::kPreserveLayoutPolicy instead.

Returns: ErrorCode - kSuccess or kFailure

virtual ErrorCode Facade::IFlowFacade::DeleteAlternateLayout	(	const UIDRef &	spreadRef,
		bool16	bDeleteMasters = `kTrue`,
		bool16	bDeleteStyleGroups = `kTrue`
	)

pure virtual

Delete an alternate layout containing the given spread. Associated master spreads and style groups are optionally deleted as well.

Parameters

spreadRef	- a UIDRef to a spread
bDeleteMasters	- kTrue to delete masters pages applied in this alternate layout, kFalse to not.
bDeleteMasters	- kTrue to delete style group named the same as this alternate layout, kFalse to not.

Returns: ErrorCode - kSuccess or kFailure

virtual ErrorCode Facade::IFlowFacade::DeletePrimaryTextFlowStory ( const UIDRef & storyRef )

pure virtual

Remove the primary text flow story for any master spread that uses it. Generally for internal use only used in response to a story getting deleted.

Parameters

storyRef - the story that is being deleted.

Returns: ErrorCode - kSuccess or kFailure

virtual void Facade::IFlowFacade::GetConstraints	(	const UIDRef &	oneItem,
		Flow::ConstraintList &	outList
	)		const

pure virtual

Return the constraints for an item in a list with Flow::kNumConstraints values. Values returned with be Flow::kFlexibleDimension (spring) or Flow::kFixedDimension (strut)

See Also: Flow::Constraint and Flow::ConstraintIndex for values.

virtual bool16 Facade::IFlowFacade::GetDuringCreateAlternateLayout ( IDocument * document ) const

pure virtual

Return the value for whether we are in the process of creating an alternate layout or not. i.e. Within the sequence generated by CreateAlternateLayout.

Parameters

document,a pointer to the document to return the flag for.

Returns: bool16, kTrue if within CreateAlternateLayout, kFalse otherwise.

virtual UIDList Facade::IFlowFacade::GetPrimaryTextFlowSplineListForMaster ( const UIDRef & pageOrSpreadMasterRef )

pure virtual

Return the list of splines on the given master (spread or page UIDRef) corresponding to the master's primary flow.

Parameters

masterRef - a UIDRef for the master spread or a master page on the master spread.

Returns: UIDList - a UIDList of primary text flow splines on that page (1 in typical case, >1 if threaded frames on that page's master)

virtual UIDList Facade::IFlowFacade::GetPrimaryTextFlowSplineListForPage	(	const UIDRef &	pageRef,
		const UIDRef &	masterRef
	)

pure virtual

Return the list of splines on a page corresponding to the master's primary flow.

Parameters

pageRef	- a UIDRef for the page
masterRef	- a UIDRef for the master to get the primary text flow spline from

Returns: UIDList - a UIDList of primary text flow splines on that page (1 in typical case, >1 if threaded frames on that page's master)

virtual UIDRef Facade::IFlowFacade::GetPrimaryTextFlowStory	(	const UIDRef &	masterSpreadRef,
		const bool16	bWalkUpMasters = `kFalse`
	)		const

pure virtual

Return the primary text flow (spline ref) associated with a master spread. kInvalidUIDRef if there isn't one.

Parameters

masterRef	- the master spread to return the spline flow for.
bWalkUpMasters	- kFalse to just return the data for that master spread, kTrue to keep walking up applied masters, stopping when a primary text frame is found.

Returns: UIDRef - the UIDRef for the spline that is the flow, kInvalidUIDRef if there isn't one.

virtual UIDRef Facade::IFlowFacade::GetStoryFromSpline ( const UIDRef & splineFlowFrameRef ) const

pure virtual

Return the story UID for the spline (containing a MultiColumnTextFrame)

Parameters

splineFlowFrameRef - the spline (containing a MultiColumnTextFrame) whose story will be the primary text flow

Returns: UIDRef - the UIDRef for the story (the text model UID), kInvalidUIDRef if no story associated with spline

virtual bool16 Facade::IFlowFacade::IsAPrimaryTextFlowStory	(	const UIDRef &	storyRef,
		UIDRef *	fromThisMaster = `nil`
	)		const

pure virtual

Returns true if the story is a primary text flow story.

Parameters

storyRef	- the story to check to see if it's a primary text flow story
fromThisMaster	[OUT] - optional pointer receive the master spread the primary text story comes from (defaults to nil)

Returns: bool16 - kTrue if story is a primary text flow story, kFalse otherwise

virtual bool16 Facade::IFlowFacade::IsInPrimaryTextFlowStory	(	const UIDRef &	masterRef,
		const UIDRef &	splineRef
	)		const

pure virtual

Returns true if the spline is in the primary text flow story.

Parameters

masterRef	- a UIDRef for the master to get the primary text flow spline from
splineRef	- the spline (containing a MultiColumnTextFrame) to check to see if it's in the primary text flow story

Returns: bool16 - kTrue if spline is in the primary text flow story for the given master, kFalse otherwise

virtual ErrorCode Facade::IFlowFacade::SetConstraints	(	const UIDList &	itemList,
		const Flow::ConstraintList &	list
	)

pure virtual

Set the layout constraints for a list of page items.

Parameters

itemList	- the list of items to set constraints for.
ConstraintList	- the constraint values to set.

Returns: ErrorCode

Common usage: Flow::ConstraintList constraints(Flow::kNumConstraints, Flow::kSkipDimension); constraints[Flow::kRightConstraint] = Flow::kFlipConstraint; SetConstraints(itemList, constraints);

virtual void Facade::IFlowFacade::SetDuringCreateAlternateLayout	(	IDocument *	document,
		const bool16	flag
	)

pure virtual

Set the value for whether we are in the process of creating an alternate layout or not. i.e. Within the sequence generated by CreateAlternateLayout.

Parameters

document,a	pointer to the document to set the flag for.
flag,the	value for the flag, kTrue for within CreateAlternates, kFalse when done.

virtual ErrorCode Facade::IFlowFacade::SetPrimaryTextFlowSpline	(	const UIDRef &	masterSpreadRef,
		const UIDRef &	splineFlowFrameRef
	)

pure virtual

Set the primary text flow for the master spread.

Parameters

masterRef	- the master spread target to set the flow
splineFlowFrameRef	- the spline (containing a MultiColumnTextFrame) whose story will be the primary text flow

Returns: ErrorCode - kSuccess or kFailure

virtual ErrorCode Facade::IFlowFacade::SetPrimaryTextFlowStory	(	const UIDRef &	masterSpreadRef,
		const UIDRef &	storyRef
	)

pure virtual

Set the primary text flow story for the master spread.

Parameters

masterRef	- the master spread target to set the flow
storyRef	- the story that will be the primary text flow

Returns: ErrorCode - kSuccess or kFailure

Public Types

Public Member Functions

Member Function Documentation