IPagesSubPanelController.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPagesSubPanelController__
#define __IPagesSubPanelController__

#include "IPMUnknown.h"
#include "PagesPanelID.h"
#include "PMTypes.h"

class PMString;
class IDocument;
class UIDList;
class PMRect;

class IPagesSubPanelController : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGESSUBPANELCONTROLLER };

 typedef enum { kNoReasonSpecified, kPageAdded, kSpreadAdded, kPagesPanelPrefsChanged } ReasonForUpdate;

 virtual bool16 ActiveDocChange(IDocument *theNewDoc) = 0;

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

 virtual void UpdatePagesPanel( bool16 bForceUpdateAll /*= kFalse*/,
 bool16 bForcePurge /*= kFalse*/, 
 IPagesSubPanelController::ReasonForUpdate reason /*= kNoReasonSpecified*/) = 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;
};

#endif