ILayoutPolicySuite Class Reference

#include <ILayoutPolicySuite.h>

Inheritance diagram for ILayoutPolicySuite:

Public Types
enum	{ kDefaultIID = IID_ILAYOUTPOLICYSUITE }

Public Member Functions
virtual bool32	GetLayoutPolicy (ILayoutObject::LayoutPolicy &outPolicy) const =0
virtual ErrorCode	SetLayoutPolicy (ILayoutObject::LayoutPolicy policy) const =0
virtual bool32	GetPageRangeString (PMString &pPageString) const =0
virtual bool32	CanApplyBasedOnMasterPolicy () const =0
virtual bool32	GetConstraints (Flow::ConstraintList &outListOfConstraints) const =0
virtual ErrorCode	SetConstraints (const Flow::ConstraintList &constraints) const =0
virtual bool32	CanApplyObjectConstraints () 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

Selection suite for manipulating HTML page items.

Member Function Documentation

virtual bool32 ILayoutPolicySuite::CanApplyBasedOnMasterPolicy ( ) const

pure virtual

Return whether or not the current page selection allows the "Based On Master" layout policy to be applied. 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.

virtual bool32 ILayoutPolicySuite::CanApplyObjectConstraints ( ) const

pure virtual

Return whether or not the current page layout policy is Object-Based and there is a selection for which object-based constraints can be applied.

virtual bool32 ILayoutPolicySuite::GetConstraints ( Flow::ConstraintList &  outListOfConstraints ) const

pure virtual

Get the object constraints applied to the selected page items or key objects

Parameters

outListOfConstraints

[OUT]: The constraints

Returns

true if object constraints are applicable. That is, if the layout policy on the selected pages is either Object-based or it is Based on Master and the master policy is Object-based.

virtual bool32 ILayoutPolicySuite::GetLayoutPolicy ( ILayoutObject::LayoutPolicy &  outPolicy ) const

pure virtual

Tests the current selection for a layout policy.

Parameters

outPolicy

[OUT]: the layout policy applied to the current selection

Returns

true if the policy is consistent across the entire selection, false if mixed.

virtual bool32 ILayoutPolicySuite::GetPageRangeString ( PMString &  pPageString ) const

pure virtual

Get a page range string for the selected pages.

Parameters

pPageString

[OUT] result page range string

Returns

true if there is a page selection

See Also

IPageList::GetPageRangeString

virtual ErrorCode ILayoutPolicySuite::SetConstraints ( const Flow::ConstraintList &  constraints ) const

pure virtual

Set object constraints on the current page item or key object selection.

Parameters

constraints

[IN]: The constraints to apply

Returns

kSuccess if successful, otherwise an error code.

virtual ErrorCode ILayoutPolicySuite::SetLayoutPolicy ( ILayoutObject::LayoutPolicy  policy ) const

pure virtual

Set the layout policy on the current selection.

Parameters

policy

[IN]: The new layout policy to apply

Returns

kSuccess if successful