IDocumentUIUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: hhorton
// 
// $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 _H_IDocumentUIUtils
#define _H_IDocumentUIUtils

#include "IPMUnknown.h"
#include "IDocument.h"
#include "IDataBase.h"
#include "IErrorState.h"
#include "AppUIID.h"
#include <boost/function.hpp>
#include "IDocumentPresentation.h"
#include "Utils.h"
#include "CAlert.h"

class PaletteRef;

typedef unary_presentation_predicate FindPresentation_CriteriaFunc;
typedef unary_presentation_predicate* FindPresentation_Criteria;
typedef std::vector<FindPresentation_Criteria> FindPresentation_PreferCriteria;

typedef binary_presentation_predicate FindRelatedPresentation_CriteriaFunc;
typedef binary_presentation_predicate* FindRelatedPresentation_Criteria;
typedef std::vector<FindRelatedPresentation_Criteria> FindRelatedPresentation_PreferCriteria;

typedef K2Vector<IDocumentPresentation*> PresentationSequence;

class IDocumentUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDOCUMENTUIUTILS };

 virtual IDocumentPresentation* GetActiveDocumentPresentation() = 0; // FIXME_OWL2: remove or convert to inline call to GetDocumentPresentationFromActiveContext when we understand more subtle cases
 
 virtual IDocumentPresentation* GetOSActivatedDocumentPresentation() = 0; 

 virtual IDocumentPresentation* FindPresentationForDocument(IDataBase* db, const FindPresentation_Criteria& acceptCriteria, const FindPresentation_PreferCriteria& preferCriteria) = 0;
 
 virtual uint32 FindPresentationsForDocument(IDataBase* db, PresentationSequence&, const FindPresentation_Criteria& acceptCriteria, const FindPresentation_PreferCriteria& preferCriteria) = 0;
 
 virtual IDocumentPresentation* GetFrontmostPresentationForDocument(IDataBase* db) = 0;

 virtual uint32 FindRelatedPresentations(IDataBase* db, IDocumentPresentation* me, PresentationSequence& myRelatives, 
 const FindRelatedPresentation_Criteria& acceptCriteria, const FindRelatedPresentation_PreferCriteria& preferCriteria,
 bool16 includeMe = kTrue) = 0;
 
 virtual void CascadeFloatingDocumentWindows( bool16 currentDocOnly ) = 0;

 virtual void TileDocumentWindows() = 0;

 //virtual void NextWindow() = 0;
 // Cycle through document tabs in the active pane
 virtual void CycleNextPresentationToFront() = 0;
 // Cycle through top level document bearing windows (CS3 behavior)
 virtual void CycleNextPresentationWindowToFront() = 0;

 //virtual void PreviousWindow() = 0;
 // Cycle through document tabs in the active pane
 virtual void CycleLastPresentationToFront() = 0;
 // Cycle through top level document bearing windows (CS3 behavior)
 virtual void CycleLastPresentationWindowToFront() = 0;

 //virtual void AdjustDocumentWindowsBounds(ClassID theTriggeringChange = kInvalidClass) = 0;
 virtual void AdjustDocumentPresentationsBounds(ClassID theTriggeringChange = kInvalidClass) = 0;

 //virtual void AdjustDocumentWindowBounds(IWindow* docWindow, ClassID theTriggeringChange = kInvalidClass) = 0;
 virtual void AdjustDocumentPresentationBounds(IDocumentPresentation* presentation, ClassID theTriggeringChange = kInvalidClass) = 0;

 // Refactored methods (from IDocumentUIUtils)
 
 virtual bool16 CloseActivePresentation(bool16 allowCancel = kTrue) = 0;

 virtual bool16 CloseActiveDocument(bool16 allowCancel = kTrue, UIFlags uiFlags = kFullUI) = 0;

 //virtual bool16 CloseDocWindow(IWindow* window, bool16 allowCancel = kTrue) = 0;
 virtual bool16 CloseDocumentPresentation(IDocumentPresentation* presentation, bool16 allowCancel = kTrue) = 0;

 virtual bool16 RevertActiveDocument(bool16 allowCancel = kTrue) = 0;

 virtual void UpdatePresentationLabels(IDocument *doc) = 0;

 virtual void UpdateDocumentIsModifiedIndicators(IDocument *doc = NULL) = 0;

 virtual void SuspendActivePresentationConsistencyCheck(bool16 suspend = kTrue) = 0;

 virtual ErrorCode DispatchPresentationSignalToAllResponders( IDocument* document, IDocumentPresentation* presentation, ServiceID serviceID ) const = 0 ;

 virtual IDocumentPresentation* GetLayoutPresentationNextToActive() = 0;

 virtual IDocumentPresentation* GetLayoutPresentationForStoryEditorPresentation(IDocumentPresentation* inStoryPresentation) = 0;

 virtual void ShowHideDocumentWindows(bool16 show) = 0;

};

#endif /* _H_IDocumentUIUtils */