#include <IOpenLayoutCmdData.h>

Inheritance diagram for IOpenLayoutPresentationCmdData:

Public Types
enum	{ kDefaultIID = IID_IOPENLAYOUTCMDDATA }

Public Member Functions
virtual void	SetPreferredBounds (const GSysRect &bBox)=0

virtual const GSysRect &	GetPreferredBounds () const =0

virtual void	SetPerspective_ (PMReal xScaleFactor, PMReal yScaleFactor, PMPoint scrollOffset, ILayoutControlData::FitSetting fit)=0

virtual void	GetPerspective_ (PMReal &xScaleFactor, PMReal &yScaleFactor, PMPoint &scrollOffset, ILayoutControlData::FitSetting &fit) const =0

virtual void	SetParentingPreferenceForCreation (IDocumentPresentation::CreationParentingPrefs parentingPrefs=IDocumentPresentation::kDefaultParentingPref, const IDocumentPresentation relativeTo=nil, const PaletteRef parentGroup=nil)=0

virtual IDocumentPresentation::CreationParentingPrefs	GetParentingPreferenceForCreation (const IDocumentPresentation relativeTo=nil, const PaletteRef parentGroup=nil) const =0

virtual void	SetCommandResult (IDocumentPresentation *)=0

virtual IDocumentPresentation *	GetResultingPresentation () 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

Data interface for commands that open a layout presentation (kNewWritingPanelCmdBoss and kOpenLayoutCmdBoss). Allows you to specify attributes about the zoom percentage and scroll location, as well as the suggested size of the layout.

Member Function Documentation

virtual IDocumentPresentation::CreationParentingPrefs IOpenLayoutPresentationCmdData::GetParentingPreferenceForCreation	(	const IDocumentPresentation **	relativeTo = `nil`,
		const PaletteRef **	parentGroup = `nil`
	)		const

pure virtual

Retrieve the suggested floating vs embedded state

Parameters

relativeTo	for relative parenting prefs, returns the presentation to position relative to
parentGroup	for parenting prefs, returns the parent group to position the new presentation in

Returns: parentingPrefs see IDocumentPresentation::CreationParentingPrefs for possible values

virtual void IOpenLayoutPresentationCmdData::GetPerspective_	(	PMReal &	xScaleFactor,
		PMReal &	yScaleFactor,
		PMPoint &	scrollOffset,
		ILayoutControlData::FitSetting &	fit
	)		const

pure virtual

Retrieve values from SetPerspective.

Parameters

xScaleFactor	OUT X Scaling factor
yScaleFactor	OUT Y Scaling factor (should match x)
scrollOffset	OUT scroll offset as a point in pasteboard coordinates.
fit	OUT the layout "fit" setting from ILayoutControlData.

virtual const GSysRect& IOpenLayoutPresentationCmdData::GetPreferredBounds ( ) const

pure virtual

Retrieve the value from SetPreferredBounds

Returns: global sys rect from SetPreferredBounds

virtual IDocumentPresentation* IOpenLayoutPresentationCmdData::GetResultingPresentation ( ) const

pure virtual

Retrieve the resulting presentation after kOpenLayoutCmdBoss is processed.

Returns: the newly created presentation.

virtual void IOpenLayoutPresentationCmdData::SetCommandResult ( IDocumentPresentation * )

pure virtual

Internal use only: The SetPresentation() method is ONLY to be called by OpenLayoutCmd!!! Do not call!!!

Parameters

IDocumentPresentation*

virtual void IOpenLayoutPresentationCmdData::SetParentingPreferenceForCreation	(	IDocumentPresentation::CreationParentingPrefs	parentingPrefs = `IDocumentPresentation::kDefaultParentingPref`,
		const IDocumentPresentation *	relativeTo = `nil`,
		const PaletteRef *	parentGroup = `nil`
	)

pure virtual

Set the parenting prefs for creation. Optional. (defaults to user pref setting)

Parameters

relativeTo	for relative parenting prefs, specify the presentation to position relative to
parentGroup	for opening a document within a particular group
parentingPrefs	see IDocumentPresentation::CreationParentingPrefs for possible values.

virtual void IOpenLayoutPresentationCmdData::SetPerspective_	(	PMReal	xScaleFactor,
		PMReal	yScaleFactor,
		PMPoint	scrollOffset,
		ILayoutControlData::FitSetting	fit
	)

pure virtual

Set various attributes about the layout that will be opened. Generally populated from IID_IDOCUMENTUISTATE, IDocumentUIState values from document workspace. Optional.

Parameters

xScaleFactor	X Scaling factor
yScaleFactor	Y Scaling factor (should match x)
scrollOffset	scroll offset as a point in pasteboard coordinates.
fit	the layout "fit" setting from ILayoutControlData.

virtual void IOpenLayoutPresentationCmdData::SetPreferredBounds ( const GSysRect & bBox )

pure virtual

The suggested size of the layout to be opened. Optional.

Parameters

bBox	suggested bbox of preentation in global system coordinates.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation