ILayoutControlData Class Reference

#include <ILayoutControlData.h>

Inheritance diagram for ILayoutControlData:

Public Types
enum	{ kDefaultIID = IID_ILAYOUTCONTROLDATA }
enum	FitSetting { kFitNone = 0, kFitSpread = 1, kFitPage = 2, kFitPasteboard = 3 }

Public Member Functions
virtual void	SetFit (FitSetting fit)=0
virtual FitSetting	GetFit ()=0
virtual void	SetSpreadRef (const UIDRef &newSpread, bool16 bDeselect, bool16 bWithinSetPageCmd=kFalse)=0
virtual UID	GetPage () const =0
virtual void	SetActiveDocLayerUID (UID newActiveLayer)=0
virtual UID	GetActiveDocLayerUID ()=0
virtual UID	GetActiveLayerUID (bool16 wantGuidesUID=kFalse, UID docLayerUID=kInvalidUID)=0
virtual IDocumentLayer *	QueryActiveDocLayer ()=0
virtual IHierarchy *	QueryActiveLayer (bool16 wantGuidesHierarchy=kFalse)=0
virtual void	GetAllSpreads (UID spreadUID, UIDList *spreadList)=0
virtual IDocument *	GetDocument ()=0
virtual void	SetCursorSnapTo (ISnapTo *snapTo)=0
virtual ISnapTo *	GetCursorSnapTo ()=0
virtual void	Shutdown (void)=0
virtual void	AttachDocObservers (const IDocument *doc)=0
virtual void	DetachWorkspaceObservers (const IDocument *doc)=0
virtual void	DetachDocObservers (const IDocument *doc)=0
virtual void	AttachWorkspaceObservers (const IDocument *doc)=0
virtual void	SetDefaultDocLayer ()=0
virtual const UIDRef &	GetSpreadRef () const =0
virtual void	AttachSpreadObservers (const UIDRef &spreadRef)=0
virtual void	DetachSpreadObservers ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Friends
class	OpenLayoutWinCmd
class	SetSpreadCmd
class	NavLayoutWidgetObs
class	CreatePrintLayoutViewCmd

Detailed Description

Data interface for the Layout Widget. Provides access to the spread, document, and currently installed selection. Note: those marked as SEIssue is obsolete, and 3rd party should not use.

Member Enumeration Documentation

enum ILayoutControlData::FitSetting

kFitNone = 0, Do no modifications to view pct; kFitSpread = 1, Fit current spread in window; kFitPage = 2, Fit current page in window; kFitPasteboard = 3 Fit all spreads in window;

Member Function Documentation

virtual void ILayoutControlData::AttachDocObservers ( const IDocument *  doc )

pure virtual

These are only to be called by OpenLayoutWinCmd. They are for initializing various things for new layout windows. These used to be called by SetSpreadRef but that doesn't really seem to make sense and actually caused problems in at least one case because of ordering problems. Attach document observers; These observers are for initializing various things for new layout windows and watch for any changes that may affect the display of layout widget. Include IID_ILAYOUTHIERARCHYOBSERVER, IID_ILAYOUTPAGEITEMOBSERVER and IID_IREFERENCEPOINTSPREADOBSERVER, as well as kLayoutActionService providers.

Parameters

doc

Returns

virtual void ILayoutControlData::AttachSpreadObservers ( const UIDRef &  spreadRef )

pure virtual

FOR Internal use only

virtual void ILayoutControlData::AttachWorkspaceObservers ( const IDocument *  doc )

pure virtual

Attach workspace observers, attach IID_ILAYOUTTEXTOPTIONSOBSERVER and IID_ILAYOUTINVALOBSERVER to workspace to catch these changes to invalidate layout.

Parameters

*doc

Returns

virtual void ILayoutControlData::DetachDocObservers ( const IDocument *  doc )

pure virtual

Detach document observers.

Parameters

doc

Returns

virtual void ILayoutControlData::DetachWorkspaceObservers ( const IDocument *  doc )

pure virtual

Detach workspace observers.

Parameters

*doc

Returns

virtual UID ILayoutControlData::GetActiveDocLayerUID ( )

pure virtual

Get the UID of the active document layer.

Parameters

none

Returns

the UID set by SetActiveDocLayerUID(UID newActiveLayer)

virtual UID ILayoutControlData::GetActiveLayerUID ( bool16  wantGuidesUID = kFalse, UID  docLayerUID = kInvalidUID  )

pure virtual

Get the UID of the active layer or spread layer specified by document layer of docLayerUID) .

Parameters

wantGuidesUID	kFalse (By default) :return the spread layer UID for the regular spread If kTrue, return the spread layer UID for the guides spread layer.
docLayerUID	kInvalidUID (by default) return the active layer, if docLayerUID is specified, return the spread layer corresponding to indicated document layer.

Returns

layer uid

virtual void ILayoutControlData::GetAllSpreads ( UID  spreadUID, UIDList *  spreadList  )

pure virtual

Returns a list of all the spreads (including hierarchal masters) that appear as part of thisSpread. NOTE (repeat), the result is not all spreads of the document, there are master spreads except itself

Parameters

spreadUID	The spread we want to collect applied masters
*spreadList	Resulting UID list of (master)spreads

Returns

virtual ISnapTo* ILayoutControlData::GetCursorSnapTo ( )

pure virtual

Get cursor snap to

Parameters

none

Returns

virtual IDocument* ILayoutControlData::GetDocument ( )

pure virtual

Get the document that this widget is currently viewing. SetDocument() is nolonger available for 3rd party

Parameters

none

Returns

current document

virtual FitSetting ILayoutControlData::GetFit ( )

pure virtual

Get current fit setting

Parameters

none

Returns

current fit setting

virtual UID ILayoutControlData::GetPage ( ) const

pure virtual

Get current page.Uses GetVisiblePageUID with current spread from GetSpreadRef.

Parameters

none

Returns

Return the "current" page on the current spread.

virtual const UIDRef& ILayoutControlData::GetSpreadRef ( ) const

pure virtual

Get current spread UIDRef, the spread this view is currently viewing

Parameters

none

Returns

current spread UIDRef.

virtual IDocumentLayer* ILayoutControlData::QueryActiveDocLayer ( )

pure virtual

Query for active document layer

Parameters

none

Returns

Active document layer

virtual IHierarchy* ILayoutControlData::QueryActiveLayer ( bool16  wantGuidesHierarchy = kFalse )

pure virtual

Query for the active layer hierarchy; Returns a spread layer or guide layer hierarchy.

Parameters

wantGuidesHierarchy

By default(kFalse)return the regular spread layer hierarchy. If kTrue, return the corresponding spread guide layer hierarchy.

Returns

virtual void ILayoutControlData::SetActiveDocLayerUID ( UID  newActiveLayer )

pure virtual

Set the UID of the active document layer.

Parameters

newActiveLayer

the UID of a document layer want to set

Returns

virtual void ILayoutControlData::SetCursorSnapTo ( ISnapTo *  snapTo )

pure virtual

Set cursor snap to value, used by cursor provider; ISnapTo could be obtained by IItemContext->QuerySnapTo();

Parameters

snapTo

Returns

virtual void ILayoutControlData::SetDefaultDocLayer ( )

pure virtual

Set default document layer. If a document layer is not set yet, set the first layer as default

Parameters

none

Returns

virtual void ILayoutControlData::SetFit ( FitSetting  fit )

pure virtual

Set fit settting

Parameters

fit	FitSetting enumerator defined above

Returns

virtual void ILayoutControlData::SetSpreadRef ( const UIDRef &  newSpread, bool16  bDeselect, bool16  bWithinSetPageCmd = kFalse  )

pure virtual

Internal use only. Set current spread to newSpread. It will also set current document to this spread's document

Parameters

*newSpread	new spread
bDeselect	if true (kDeselect), deselect all layout selection. If kFalse (kDontDeselect), selection remains unchanged.
bWithinSetPageCmd	if true, change has been made within a SetPageCmd

Returns

virtual void ILayoutControlData::Shutdown ( void  )

pure virtual

The layout window is about to go away, release the items that are stored in the docuemnt database and detach observers; Called when the window is being closed.

Parameters

void

Friends And Related Function Documentation

friend class CreatePrintLayoutViewCmd

friend

SEIssue this is temporary

friend class NavLayoutWidgetObs

friend

SEIssue this is temporary

friend class OpenLayoutWinCmd

friend

SEIssue this is temporary

friend class SetSpreadCmd

friend

SEIssue this is temporary