#include <IPagesSubPanelController.h>

Inheritance diagram for IPagesSubPanelController:

Public Types
enum	{ kDefaultIID = IID_IPAGESSUBPANELCONTROLLER }

enum	ReasonForUpdate { kNoReasonSpecified, kPageAdded, kSpreadAdded, kPagesPanelPrefsChanged }

Public Member Functions
virtual bool16	ActiveDocChange (IDocument *theNewDoc)=0

virtual void	AddPageToPanel (int32 numPages, const UIDRef &spreadUID)=0

virtual void	UpdatePagesPanel (bool16 bForceUpdateAll, bool16 bForcePurge, IPagesSubPanelController::ReasonForUpdate reason)=0

virtual bool16	IsPanelUpdatePending ()=0

virtual void	AddSpreadToPanel (const UIDList *spreadList)=0

virtual void	ScrollPanelToSpread (const UIDRef &spreadUID)=0

virtual void	AboutToDraw (SysRgn updateRgn)=0

virtual void	GetPanelPanoramaBounds (PMRect *panoramaRect)=0

virtual void	PagesPanelResized ()=0

virtual void	PagesPanelClosed ()=0

virtual bool16	InvalidateSpreadWidget (const UIDRef &spreadUID)=0

virtual bool16	InvalidatePageWidget (const UIDRef &spreadUID, const UIDRef &pageUID)=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

Interface that controls the two sub-panels of the pages panel; the observers that watch the document for relevant changes trigger pages panel updates via this interface.

Member Function Documentation

virtual void IPagesSubPanelController::AboutToDraw ( SysRgn updateRgn )

pure virtual

Called when the pages panel is just about to draw. If there is a pending update, this may do a lot of work.

Parameters

updateRgn area that is going to draw

virtual bool16 IPagesSubPanelController::ActiveDocChange ( IDocument * theNewDoc )

pure virtual

Called to update the pages panel when the active document has changed

Parameters

theNewDoc IDocument pointer of the newly active document (may be nil, when last document is closed)

virtual void IPagesSubPanelController::AddPageToPanel	(	int32	numPages,
		const UIDRef &	spreadUID
	)

pure virtual

Called to update the pages panel when a page is added (or undeleted)

Parameters

numPages	number of pages added
spreadUID	spread pages were added to

virtual void IPagesSubPanelController::AddSpreadToPanel ( const UIDList * spreadList )

pure virtual

Called to update the pages panel when a spread has been added

Parameters

spreadList list of added spreads

virtual void IPagesSubPanelController::GetPanelPanoramaBounds ( PMRect * panoramaRect )

pure virtual

Gets the bounds of the panorama the pages panel is viewing

Parameters

panoramaRect returned bounds

virtual bool16 IPagesSubPanelController::InvalidatePageWidget	(	const UIDRef &	spreadUID,
		const UIDRef &	pageUID
	)

pure virtual

Called to invalidate a single page widget in the pages panel

Parameters

spreadUID	UID of the spread containing the page widget
pageUID	UID of the page whose widget should be invalidated

virtual bool16 IPagesSubPanelController::InvalidateSpreadWidget ( const UIDRef & spreadUID )

pure virtual

Called to invalidate a single spread widget in the pages panel

Parameters

spreadUID UID of the spread whose widget should be invalidated

virtual bool16 IPagesSubPanelController::IsPanelUpdatePending ( )

pure virtual

Called to check the update state of the pages panel

Returns: set to true if the pages panel has an update pending; false otherwise

virtual void IPagesSubPanelController::PagesPanelClosed ( )

pure virtual

Called when the panel is closed - sent when the panel has gone away (hook to free any memory being held)

virtual void IPagesSubPanelController::PagesPanelResized ( )

pure virtual

Called when the panel has been resized

virtual void IPagesSubPanelController::ScrollPanelToSpread ( const UIDRef & spreadUID )

pure virtual

Scroll the pages panel to view a particular page or spread

Parameters

spreadUID spread or page uid to scroll into view in the pages panel

virtual void IPagesSubPanelController::UpdatePagesPanel	(	bool16	bForceUpdateAll,
		bool16	bForcePurge,
		IPagesSubPanelController::ReasonForUpdate	reason
	)

pure virtual

Called to update the pages panel

Parameters

bForceUpdateAll	set to true if all page tab widgets should be updated (expensive)
bForcePurge	set to true to delete all cached page tab widgets (expensive)
reason	why update is being called

Public Types

Public Member Functions

Detailed Description

Member Function Documentation