Inheritance diagram for IAdaptiveHelper:

Public Types
enum	{ kDefaultIID = IID_IADAPTIVEHELPER }

Public Member Functions
virtual PMRect	GetBoundsForPageItem (UIDRef pageItemRef)=0

virtual PMRect	GetFinalBoundsForPageItem (const UIDRef &pageItemRef, const PMRect &initialBounds, const uint32 &options=0)=0

virtual void	SetRecommendedBoundsForPageItem (UIDRef pageItemRef, PMRect recommendedBounds)=0

virtual bool16	ShouldHandleHidden ()=0

virtual bool16	ShouldHandleLocked ()=0

virtual bool16	ShouldHandleText ()=0

virtual bool16	ShouldMaintainAspectRatioForNonRectangularPI ()=0

virtual bool16	ShouldMaintainAspectRatioForPI (UIDRef pageItemRef)=0

virtual void	RegisterMaxFontScaleOf (UID uid, PMReal fontScale)=0

virtual PMReal	GetBestPossibleTextScaleFactor (const UIDRef uidRef, const PMReal &hScale, const PMReal &vScale)=0

virtual PMReal	GetFontScale (UID itemUID)=0

virtual bool16	LiesInsideMargin (const UIDRef &pageItemRef, const PMRect &initialBounds)=0

virtual ErrorCode	AdjustEffects (const UIDList &itemList, const PMRect &initialBounds, const PMRect &finalBounds)=0

virtual PMPoint	GetMinSizeOfObject (UIDRef pageItemRef)=0

virtual PMRect	GetRelativeFinalBounds (PMRect initialBounds, PMRect initialReferenceBounds, PMRect finalReferenceBounds)=0

virtual PMReal	GetMaxAllowedFontSize ()=0

virtual PMReal	GetMinAllowedFontSize ()=0

virtual void	PreprocessText (UIDRef uidRef)=0

virtual UID	GetSpreadUID (UIDRef pageItemUID)=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 PMRect IAdaptiveHelper::GetBoundsForPageItem ( UIDRef pageItemRef )

pure virtual

The Adaptive layout adjustment happens on the basis of bounds in spread coordinates. This is a simple utility which gives relevant bounds.

Parameters

pageItemRef IN The reference to the page item for which the bounds are to be returned.

Returns: bounds of the page item in spread coordinates.

virtual PMRect IAdaptiveHelper::GetFinalBoundsForPageItem	(	const UIDRef &	pageItemRef,
		const PMRect &	initialBounds,
		const uint32 &	options = `0`
	)

pure virtual

Based on the initial bounds and some optional controllable options give the final recommended bounds.

Parameters

pageItemRef	IN The reference to the page item for which the bounds are to be returned.
initialBounds	IN The bounds of the page item before any change in the layout took place.
options	IN The options with which the calculation is to be done. The options are build up of values from OptionsFlag.

Returns: final bounds of the page item in spread coordinates.

virtual void IAdaptiveHelper::SetRecommendedBoundsForPageItem	(	UIDRef	pageItemRef,
		PMRect	recommendedBounds
	)

pure virtual

This API is used by page item to set the recommended bounds on the other page item. e.g. a page item may want to decide the final bounds for its children. This would cause any subsequent call to GetFinalBoundsForPageItem() to return these bounds.

Parameters

pageItemRef	IN The reference to the page item for which the final bounds are to be set.
recommendedBounds	IN The bounds to be set as the final bounds.

virtual bool16 IAdaptiveHelper::ShouldHandleHidden ( )

pure virtual

Returns whether the hidden objects are to be adjusted or not. A page item should generally follow this but in cases it may choose to ignore the flag.

Returns: kTrue if the hidden items are to be adjusted.

virtual bool16 IAdaptiveHelper::ShouldHandleLocked ( )

pure virtual

Returns whether the locked objects are to be adjusted or not. A page item should generally follow this but in cases it may choose to ignore the flag.

Returns: kTrue if the locked items are to be adjusted.

virtual bool16 IAdaptiveHelper::ShouldHandleText ( )

pure virtual

Returns whether the text is to be adjusted or not. A page item should generally follow this but in cases it may choose to ignore the flag.

Returns: kTrue if the text is to be adjusted.

virtual bool16 IAdaptiveHelper::ShouldMaintainAspectRatioForNonRectangularPI ( )

pure virtual

Returns whether the aspect ratio is to be maintained for the non rectangular objects. A page item should generally follow this but in cases it may choose to ignore the flag.

Returns: kTrue if the aspect ratio is to be maintained for the non rectangular objects.

virtual bool16 IAdaptiveHelper::ShouldMaintainAspectRatioForPI ( UIDRef pageItemRef )

pure virtual

Returns whether the aspect ratio is to be maintained for the page item being passed.

Parameters

pageItemRef IN The reference to the page item.

Returns: kTrue if the aspect ratio is to be maintained for the said page item.

Public Types

Public Member Functions

Member Function Documentation