IDocumentPresentation.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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 __IDOCUMENTPRESENTATION__
#define __IDOCUMENTPRESENTATION__

#include "IPMUnknown.h"
#include "PMTypes.h" //GSysRect
#include "AppUIID.h"
#include "ISelectionMessages.h"
#include "ScriptData.h"
#include "IWindow.h"

class IDocument;
class IControlView;
class ISelectionManager;

class IDocumentPresentation : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IDOCUMENTPRESENTATION};
 
 virtual IDocument* GetDocument() const = 0;

 virtual UIDRef GetDocumentUIDRef() const = 0;

 // virtual PaletteRef GetPaletteRef() const = 0; // use PaletteRefUtils::GetPaletteRefFromDocumentPresentation(this) instead.


 virtual bool16 IsVisible() const = 0;

 virtual bool16 IsFloating() const = 0;
 
 virtual void Float() = 0;
 
 virtual bool16 IsMinimized() const = 0; 

 virtual void Minimize() = 0;

 virtual bool16 IsMaximized() const = 0; 

 virtual void Maximize() = 0;

 virtual bool16 IsActive() const = 0;
 
 virtual void MakeActive() = 0;

 virtual bool16 IsFrontmostInTabGroup() const = 0;
 
 virtual void MakeFrontmostInTabGroup() = 0;
 
 virtual SysRect GetPresentationBounds() const = 0;

 virtual SysRect GetPresentationPlatformBounds() const = 0;

 virtual SysSize GetPreferredSize() const = 0;
 virtual void ChangePreferredSize(const SysSize&) = 0;

 virtual SysSize GetPreferredConstrainedSize() const = 0;

 virtual void ChangePreferredConstrainedSize(const SysSize&) = 0;

 // Get/Change allowable size ranges associated with a document window
 // (Prior to CS3, this was done with calls to IWindow::Get/SetLimits)

 virtual void GetWidthRange(float* min, float* max) const = 0;
 virtual void ChangeWidthRange(float min, float max) = 0;
 
 virtual void GetHeightRange(float* min, float* max) const = 0;
 virtual void ChangeHeightRange(float min, float max) = 0;

 virtual bool16 GetDocumentModifiedState() const = 0;
 
 virtual void ChangeDocumentModifiedState(bool16) = 0;
 
 enum { kDefaultParentingPref = 0, 
 kCreateNewFloatingDock = 1, 
 kCreateNewFloatingDock_ObscureRelative = 2, 
 kCreateNewFloatingDock_DontObscureRelative = 3, 
 kAsSiblingOfRelative = 4, // add at end of same group as sibling
 kInNewTabGroupFromRelative = 5, 
 kInNewPaneFromRelative = 6,
 kAsSiblingToLeftOfRelative = 7, 
 kAsRightmostChildOfParent = 8, 
 
 kLastParentRelativePref = kAsRightmostChildOfParent,
 kParentingRelatedPrefMask = 255, // use this mask when comparing parent related prefs
 
 kDontMakeVisible = 512, // by default the new presentation is made visible, set this bit to keep document hidden
 kDontBringToFront = 1024, // by default the new presentation is also brought to the front, set this bit to put the document behing the current front document
 
 kLastParentingFlag = kDontBringToFront,
 };
 typedef uint16 CreationParentingPrefs;

 virtual IDocumentPresentation* CreateNewPresentation( IDocument* doc, IPMUnknown* targetBossContentToSelect, CreationParentingPrefs parentPref = kCreateNewFloatingDock_ObscureRelative) const = 0;

 virtual IDocumentPresentation* ViewInNewPresentation( GSysRect withinBounds, CreationParentingPrefs parentPref = kDefaultParentingPref) const = 0;

 virtual ICommand* CreateCloseCommand(bool16 allowCancel = kTrue) = 0;
 
 enum SchedulingBehavior {kProcessCommandBehavior = 0, kScheduleCommandBehavior = 1};
 virtual ErrorCode ClosePresentation(SchedulingBehavior when = kProcessCommandBehavior, bool16 allowCancel = kFalse) = 0;

 virtual bool16 IsAutonomous() = 0;

 virtual void GetPresentationLabels(PMString& titleLabel, PMString& extendedTitleLabel, PMString& toolTipLabel) const = 0;

 virtual void SetPresentationLabels(const PMString& titleLabel, const PMString& extendedTitleLabel, const PMString& toolTipLabel = kNullString) = 0;

 virtual K2Vector<IDocumentPresentation*>::iterator UpdatePresentationLabels( K2Vector<IDocumentPresentation*>::iterator begin, K2Vector<IDocumentPresentation*>::iterator end) = 0;

 virtual bool16 Helper_InstallPresentationContent( IDocument* doc, IPMUnknown* commandData, IControlView* mimicView = nil) = 0;

 class SamePresentationKind
 {
 public:
 virtual ~SamePresentationKind(){}
 virtual bool16 operator()(IDocumentPresentation* other) = 0;
 };

 class SamePresentationContent
 {
 public:
 virtual ~SamePresentationContent(){}
 virtual bool16 operator()(IDocumentPresentation* other) = 0;
 };
 
 virtual SamePresentationKind* GetPresentationKind() = 0;


 virtual SamePresentationContent* GetPresentationContent() = 0;

 virtual ErrorCode SelectScriptObjects (const ScriptID& action, ScriptList& objectList, const ScriptInfo::RequestContext& context) = 0;

 virtual IControlView* QuerySelectableView (ISelectionManager* iSelectionManager) = 0;

 virtual bool16 SetupTarget( IPMUnknown* selectedContent) = 0;

 virtual bool16 EditTarget( PMString* menuString, IPMUnknown* selectedContent) = 0;

 virtual void RegisterSelectableView (IControlView*) = 0;

 virtual void UnregisterSelectableView (IControlView*) = 0;

 virtual void GetSelectableViews (K2Vector<IControlView*>& views) = 0;

 virtual bool16 IsPresentationActiveInTouchWorkspace() = 0;

 virtual void SetPresentationActiveInTouchWorkspace(bool16 bFlag) = 0;
};

typedef bool (unary_presentation_predicate)(IDocumentPresentation*);
typedef bool (binary_presentation_predicate)(IDocumentPresentation*, IDocumentPresentation*);



#endif