ILayoutControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Frits Habermann
// 
// $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 __ILayoutControlData__
#define __ILayoutControlData__

#include "IPMUnknown.h"
#include "LayoutUIID.h"

class IGeometry;
class IDocumentLayer;
class IHierarchy;
class IDocumentLayer;
class IDocument;
class ISnapTo;
class UIDList;



class ILayoutControlData : public IPMUnknown
{
 friend class OpenLayoutWinCmd; 
 friend class SetSpreadCmd; 
 friend class NavLayoutWidgetObs; 
 friend class CreatePrintLayoutViewCmd; 
 
public:
 enum { kDefaultIID = IID_ILAYOUTCONTROLDATA };

 enum 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
 };

 // ----- View stuff -----


 virtual void SetFit(FitSetting fit) = 0;

 virtual FitSetting GetFit() = 0;

 // ----- Spread stuff -----

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

 // ----- Page stuff -----

 virtual UID GetPage() const= 0;
 

 // ----- Layer stuff -----


 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;

 
 // ----- Master page stuff -------

 virtual void GetAllSpreads(UID spreadUID, UIDList *spreadList) = 0;

 // ----- Document stuff -----

private: 
 virtual void SetDocument(IDocument *doc) = 0;
public:

 virtual IDocument* GetDocument() = 0;
 // Set and get the document that this widget is currently
 // viewing. SetDocument is called with nil when the layout window is closing.
 // Allows observers hooked up via layout actions to detach.


 // ----- Snap to stuff (used by cursor providers only, not trackers) -----

 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;
};

#endif