#include <ILayoutViewUtils.h>

Inheritance diagram for ILayoutViewUtils:

Public Types
enum	{ kDefaultIID = IID_ILAYOUTVIEWUTILS }

Public Member Functions
virtual void	ShowSplitLayoutView (IDocumentPresentation *documentPresentation)=0

virtual void	HideSplitLayoutView (IDocumentPresentation *documentPresentation)=0

virtual void	ToggleSplitLayoutView (IDocumentPresentation *documentPresentation)=0

virtual bool16	IsSplitLayoutViewShown (IDocumentPresentation *documentPresentation) const =0

virtual void	GetAllLayoutViews (K2Vector< IControlView * > &layoutViews, const IControlView exceptView, IDataBase db)=0

virtual void	ZoomLayoutViews (K2Vector< IControlView * > &layoutViews, K2Vector< PBPMPoint > &zoomToPoints, bool16 bZoomIn, PMReal newScaleFactor=-1, ILayoutControlData::FitSetting fit=ILayoutControlData::kFitNone)=0

virtual void	GatherSpreadRects (PMRectCollection &rectList, IDocument *document)=0

virtual PBPMPoint	TransformPointToNewSpread (const PBPMPoint &sourcePoint, const PBPMPoint &targetPoint, PMRectCollection &rectList)=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

Layout-view related utilities

Member Function Documentation

virtual void ILayoutViewUtils::GatherSpreadRects	(	PMRectCollection &	rectList,
		IDocument *	document
	)

pure virtual

Internal use only. Gather all the spread rectangles (in PasteboardCoordinates) for a given document.

Parameters

rectList	OUT an PMRectCollection to hold the return rectangles
document	IN a document to collect the spread rectangles for.

virtual void ILayoutViewUtils::GetAllLayoutViews	(	K2Vector< IControlView * > &	layoutViews,
		const IControlView *	exceptView,
		IDataBase *	db
	)

pure virtual

Gather all the presentations with a layout view.

Parameters

layoutViews	OUT a K2Vector to gather a list of layout views (will return both layout views in a split layout view if both shown)
exceptView	IN an optional control view to avoid putting in return list, may be nil to gather all views
db	IN the document to collect views for, nil to collect all layout views

virtual void ILayoutViewUtils::HideSplitLayoutView ( IDocumentPresentation * documentPresentation )

pure virtual

Removes the secondary layout widget from the presentation.

Parameters

documentPresentation the document view that should be modified.

virtual bool16 ILayoutViewUtils::IsSplitLayoutViewShown ( IDocumentPresentation * documentPresentation ) const

pure virtual

Returns kTrue if there is a secondary layout widget shown, kFalse otherwise.

Parameters

documentPresentation the document view that should be switched.

Returns: bool16 kTrue if split layout view is shown, kFalse otherwise.

virtual void ILayoutViewUtils::ShowSplitLayoutView ( IDocumentPresentation * documentPresentation )

pure virtual

Shows the secondary layout widget to the presentation.

Parameters

documentPresentation the document view that should be modified.

virtual void ILayoutViewUtils::ToggleSplitLayoutView ( IDocumentPresentation * documentPresentation )

pure virtual

Toggles the split layout view mode

Parameters

documentPresentation the document view that should be switched.

virtual PBPMPoint ILayoutViewUtils::TransformPointToNewSpread	(	const PBPMPoint &	sourcePoint,
		const PBPMPoint &	targetPoint,
		PMRectCollection &	rectList
	)

pure virtual

Internal use only.

virtual void ILayoutViewUtils::ZoomLayoutViews	(	K2Vector< IControlView * > &	layoutViews,
		K2Vector< PBPMPoint > &	zoomToPoints,
		bool16	bZoomIn,
		PMReal	newScaleFactor = `-1`,
		ILayoutControlData::FitSetting	fit = `ILayoutControlData::kFitNone`
	)

pure virtual

Internal use only. Zoom all the given layout views. Either zoom in or out based on bZoomIn parameter. Also, client may provide a new scale factor for the zoom if desired. If not provided, zoom occurs by one zoom level.

Parameters

layoutViews	IN a K2Vector of layout views to zoom
zoomToPoints	IN a K2Vector of points in pb coordinate space to zoom on. If empty, use center of view as zoom point.
bZoomIn	IN a bool16 value to specify whether to zoom in (kTrue) or out (kFalse). Ignored if newScaleFactor is provided.
fit	Use a fit-to setting instead of a zoom percentage.

See Also: ILayoutUIUtils, GetNextZoomValue

Public Types

Public Member Functions

Detailed Description

Member Function Documentation