Facade::ISpreadFacade Class Reference

#include <ISpreadFacade.h>

Inheritance diagram for Facade::ISpreadFacade:

Public Types
enum	{ kDefaultIID = IID_ISPREADFACADE }

Public Member Functions
virtual ErrorCode	SetPageColorLabel (UIDList pagesOrSpreads, UIDRef color)=0
virtual const UID	GetPageColorLabel (UIDRef page)=0
virtual void	GetEffectiveLayoutPolicy (const UIDList &pageList, ILayoutObject::LayoutPolicyList &outList) const =0
virtual void	GetLayoutPolicy (const UIDList &pageList, ILayoutObject::LayoutPolicyList &outList) const =0
virtual ErrorCode	SetLayoutPolicy (const UIDList &pageList, ILayoutObject::LayoutPolicy policy)=0
virtual bool32	CanApplyBasedOnMasterPolicy (const UIDList &pageList) const =0
virtual void	GetOptionalPage (const UIDList &pageList, K2Vector< bool16 > &outList) const =0
virtual ErrorCode	SetOptionalPage (const UIDList &pageList, bool16 optional)=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

A high level API for dealing with Spreads and Pages. To use this Facade, include this header file and use the following example syntax: result = Utils<Facade::ISpreadFacade>()->SetPageColorLabel( ... );

Author

Bob Freeman

Member Function Documentation

virtual bool32 Facade::ISpreadFacade::CanApplyBasedOnMasterPolicy ( const UIDList &  pageList ) const

pure virtual

Determine whether or not the "Based on Master" layout policy can take effect on the given list of pages. The "Based On Master" layout policy can only be applied if the applied master page's geometry is coincident with the selected page's geometry.

Parameters

pageList

[IN]: The list of pages to test

Returns

kTrue if the "Based on Master" layout policy can take effect on the given list of pages.

virtual void Facade::ISpreadFacade::GetEffectiveLayoutPolicy ( const UIDList &  pageList, ILayoutObject::LayoutPolicyList &  outList  ) const

pure virtual

Get the list of unique effective layout policies for the given list of pages. Here, "effective" means that if the layout policy is "Controlled by Master", then we'll return the master's layout policy if it honors the rules for being a "controller" or No Layout Policy otherwise.

Parameters

pageList	[IN]: The list of source pages
outList	[OUT]: The list of layout policies that are applied to the given source pages. Duplicates are removed.

virtual void Facade::ISpreadFacade::GetLayoutPolicy ( const UIDList &  pageList, ILayoutObject::LayoutPolicyList &  outList  ) const

pure virtual

Get the list of unique layout policies for the given list of pages

Parameters

pageList	[IN]: The list of source pages
outList	[OUT]: The list of layout policies that are applied to the given source pages. Duplicates are removed.

virtual void Facade::ISpreadFacade::GetOptionalPage ( const UIDList &  pageList, K2Vector< bool16 > &  outList  ) const

pure virtual

Determine the optional page setting for the page(s).

Parameters

pageList	[IN]: The list of source pages
outList	[OUT]: The list of optional page settings that are applied to the given source pages. Duplicates are removed. Empty if no items list have an optional page setting.

virtual const UID Facade::ISpreadFacade::GetPageColorLabel ( UIDRef  page )

pure virtual

Gets the current page color flag color for a given page. If the color is not set, kInvalidUID is returned.

Parameters

page	- Parent page item under which to create the new MultiColumnTextFrame. parent.GetDataBase() must be non-nil, if parent.GetUID() is set to kInvalidUID then a new kSplineItemBoss will be created.

Returns

UID - UID of the UI Color that is set. kInvalidUID is returned if the color is not set.

virtual ErrorCode Facade::ISpreadFacade::SetLayoutPolicy ( const UIDList &  pageList, ILayoutObject::LayoutPolicy  policy  )

pure virtual

Set the given layout policy on the given list of pages

Parameters

pageList	[IN]: The list of target pages
policy	[IN]: The policy to apply.

Returns

an ErrorCode

virtual ErrorCode Facade::ISpreadFacade::SetOptionalPage ( const UIDList &  pageList, bool16  optional  )

pure virtual

Set the list of pages to have the given optional page setting

Parameters

pageList	[IN]: The list of target pages
policy	[IN]: The optional page setting to apply.

Returns

an ErrorCode

virtual ErrorCode Facade::ISpreadFacade::SetPageColorLabel ( UIDList  pagesOrSpreads, UIDRef  color  )

pure virtual

Sets the page color flag color for one or more pages. The pages in the list must all be of the same type: Master or Layout and pages or spread. For example, you can have a list of master spreads or a list of Layout pages but not a mixture.

Parameters

pagesOrSpreads	- pages to set the page color flag on. If the page is a master, all dependent pages will also have their flags set.
color	- The UIDRef of the UI color to set the flag to.

Returns

ErrorCode - result of the operation.