ILayoutUIUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __ILayoutUIUtils__
#define __ILayoutUIUtils__


#include "LayoutID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "PMRect.h"
#include "ILayoutControlData.h"
#include "ISnapTo.h" // SnapType
#include "UIDRef.h"
#include "PMMatrix.h"
#include "UIDList.h"
#include "HitTestDragConstants.h"
#include "IDocumentPresentation.h"
#include "IInterfaceColors.h"

class IControlView;
class IDocument;
class ISpread;
class IWindow;
class IViewPort;
class IHierarchy;
class IMargins;
class IColumns;
class IMasterSpreadList;
class IStringListControlData;
class IRulerData;
class IGraphicsContext;
class IDataExchangeHandler;
class IPanorama;
class ISpreadList;
class ICommand;
class ILayoutData;
class ISnapTo;
class IWorkspace;
class IFrameList;
class IUIDListData;
class IHyperlinkDestination;
class IShape;

class ILayoutUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILAYOUTUIUTILS };

 enum IncludeOptions {
 includeVisibleOnly = 0, 
 includeHiddenOnly, 
 includeBoth,
 includeVisibleURLsOnly,
 includeVisibleEmailsOnly,
 includeVisibleFilesOnly,
 };

 virtual IControlView* QueryFrontView() = 0;//SEIssue <sheridan>

 virtual IDocument* GetFrontDocument() = 0;//SEIssue <sheridan>
 
 virtual IDocumentPresentation* CreateNewLayoutPresentation(IDataBase* whichDoc, IDocumentPresentation::CreationParentingPrefs parentPref = IDocumentPresentation::kDefaultParentingPref, const IDocumentPresentation *relative = NULL) = 0;

 virtual ICommand* CreateNewLayoutPresentationCmd(IDataBase* whichDoc = 0) = 0;

 virtual bool IsLayoutPresentation(IDocumentPresentation *inPresentation) = 0;

 virtual ILayoutControlData* QueryLayoutData(IPMUnknown *inPresentation) = 0;//SEIssue <sheridan>

 virtual ILayoutControlData* QueryFrontLayoutData() = 0;//SEIssue <sheridan>

 /*
 virtual IViewPort* QueryViewPort(IPMUnknown *vmBoss) = 0;
 // Query for the viewmaster, then query for the
 // requested viewport type.
 */
 
 virtual bool16 IsApplicationInNoPubWindowState() = 0;

 virtual bool16 GetUIDocumentWindowCount() = 0;//SEIssue <sheridan>


// virtual IMargins* QueryFrontMargins(int32 whichPage = 0, ISpread* currentSpread = nil) = 0;//SEIssue <sheridan>

// virtual IColumns* Query_FrontColumns(int32 whichPage = 0, ISpread* currentSpread = nil) = 0;//SEIssue <sheridan>
 // Return the columns of the spread associated with the frontmost layout window, or the
 // indicated spread if the optional argument is used.

 virtual void GetSelectedPages(UIDList& pageUIDList, bool16 bIncludeMasters = kTrue, bool16 bCurrentPageOnly = kFalse, bool16 bPagesOnly = kTrue) = 0;

 virtual UID GetPageUIDFromWidget(IControlView* view, IDocument* iDocument) = 0;
 
 virtual void SetPageUIDForWidget(IControlView* view, const UIDRef& pageRef) = 0;

 virtual IWorkspace* QueryActiveWorkspace() = 0;

 virtual UID GetVisiblePageUID(IControlView* layoutView, IGeometry* spreadGeometry = nil) = 0;

 virtual UID GetVisibleSpreadUID(IControlView* layoutView, ISpreadList* spreadList) = 0;

 virtual UID GetVisibleMasterSpreadUID(IControlView* layoutView, IMasterSpreadList* masterList) = 0;

 virtual void EnableUpdateAllDocumentViews() = 0;
 virtual void DisableUpdateAllDocumentViews() = 0;
 virtual void InvalidateViews (IDocument* iDoc) = 0;

 virtual void SetPathSelectionMode(bool16 isPathSelected) = 0;

 virtual bool16 GetPathSelectionMode() = 0;

 virtual ICommand* MakeScrollToSpreadCmd(IControlView *controlView, IGeometry* spreadGeometry = nil, bool16 bMakeVisibleSpreadActive = kTrue) = 0;

 virtual PMReal GetNextZoomFactor(IControlView* controlView, bool32 zoomIn, bool32 adjustForMonitorPPI = kTrue) = 0;

 virtual PMReal GetNextZoomValue(PMReal currentZoom, bool32 zoomIn) = 0;

 virtual ICommand* MakeZoomInCmd(IControlView *controlView, bool16 bJustZoomToPoint = kTrue) = 0;

 virtual ICommand* MakeZoomOutCmd(IControlView *controlView, bool16 bJustZoomToPoint = kTrue) = 0;

 virtual ICommand* MakeZoomCmd(IControlView *controlView, PMReal zoomPct, 
 ILayoutControlData::FitSetting fit = ILayoutControlData::kFitNone,
 bool16 bJustZoomToPoint = kTrue, PMPoint pt = kZeroPoint, 
 bool16 bMakeVisibleSpreadActive = kTrue) = 0;

 virtual ISnapTo* QueryAndPrepareSnapToForSpread(IControlView* controlView, ISpread* spread, const UIDList* itemList, 
 const UIDRef& originalSpread, PBPMPoint originalPoint) = 0;
 // traverse up the hierarchy looking for one of the specified interfaces

 virtual IPMUnknown* QueryWidgetParentFor( IPMUnknown *pUnknown, const PMIID &rIID ) = 0;

 virtual SnapType ConstrainPointForSnapping(PMPoint& toHere, const PMPoint& originalPoint, bool16 shiftDown, const PMReal& zoomPct) = 0;

 virtual bool16 AreSelectedPageItemsVisible(IControlView* controlView) = 0;

 virtual bool16 IsCurrentSpreadVisible(IControlView* controlView) = 0;

 virtual IRulerData* QueryHorzRulerData (IPMUnknown* layoutView) = 0;

 virtual IRulerData* QueryVertRulerData (IPMUnknown* layoutView) = 0;

 virtual PMPoint ComputeRulerAdjustedPoint
 (
 const PMPoint& pbPtIn, 
 IRulerData* iHorzRuler, 
 IRulerData* iVertRuler,
 const PMMatrix& pbtoview
 ) = 0;

 virtual PMRect ComputeRulerAdjustedRect
 (
 const PMRect& pbRectIn, 
 IRulerData* iHorzRuler, 
 IRulerData* iVertRuler, 
 const PMMatrix& pbtoview
 ) = 0;

 virtual PMPoint ComputePasteboardPoint
 (
 const GSysPoint& inGlobalPoint,
 IControlView* layoutView 
 ) = 0; 

 virtual PBPMPoint GlobalToPasteboard(IControlView* controlView, const GSysPoint& thePoint) = 0;


 virtual PMRect GetViewedSpreadsBounds(IControlView* layoutView) = 0;

 virtual UIDList GetVisibleSpreads(IControlView* layoutView) = 0;

 virtual UIDList GetVisibleSpreads(IControlView* layoutView, const PMRect& viewBounds) = 0;


 enum SpreadVisibility { kSpreadIsNotVisible, kSpreadIsPartiallyVisible, kSpreadIsCompletelyVisble};
 virtual SpreadVisibility IsSpreadVisible( ILayoutControlData* layout, ISpread* spread) = 0;



 virtual UID GetVisibleMCFrames(IControlView* layoutControlView, IFrameList* frameList, UIDList& visibleMCTextFrames) = 0;


 virtual void MakeVisibleSpreadActive(IControlView* controlView) = 0;

 virtual void DrawFloor(IGraphicsContext* gc, IDocument* theDocument, const PMRect& viewBounds, const UIDList& visibleSpreads) = 0;

 virtual bool16 CanDisplayTransformDialog() = 0;

 virtual bool16 CanDisplayMoveDialog() = 0;
 
 virtual void CloseDialogWindow() = 0;

 virtual void FillListWithHyperlinkDestinations(IStringListControlData *stringList, IDataBase *db, UIDList *uids, 
 K2Vector<ClassID> *bossList, IncludeOptions includeOptions = includeVisibleOnly, 
 bool16 bSorted = kFalse) = 0;

 

 virtual PMReal GetNewScaleFactor(const PMRect& rect, IControlView *controlView) = 0;

 virtual bool16 IsPreviewOn(IPMUnknown* layoutView) = 0;

 virtual void AddNewPage() = 0;

// virtual void AdjustPointPosition(PMPoint& pointPos, ISpread* currentSpread) = 0;
 // replace calls with: pointPos -= Utils<ITransformUpdateUtils>()->PasteboardZeroPoint( currentSpread, pointPos);


 virtual PMPoint GetMousePasteboardPosition(const SysPoint& globalLocation, IControlView* iCurrentView) = 0;

 virtual IUIDListData *QueryHitTestResultsByUIDList(IPMUnknown *owner, const PBPMPoint *pWherePt, const PMRect *pWhereRect, const ClassID handlerClass, UIDList *pTheSpreads, int16 tolerance = kHitTestTolerance, bool16 bVisibleSpreads = kFalse, bool16 bUsePt = kTrue, bool16 bUseXform = kTrue, bool16 bFinishChildren = kFalse ) = 0;

 virtual IPMUnknown *QueryInterfaceUsingHitTest(IPMUnknown *owner, const PBPMPoint *pWherePt, const PMRect *pWhereRect, const ClassID handlerClass, const PMIID& interfaceID, int16 tolerance = kHitTestTolerance, bool16 bVisibleSpreads = kFalse, bool16 bUsePt = kTrue ) = 0;


 virtual ClassID GetHitTestFlagsToHandlerBoss(const int32 selectionMode) = 0;

 virtual bool16 IsPresentationMode(IDocumentPresentation * documentPresentation = nil) = 0;

 virtual void HandleAction(ActionID actionID) = 0;

 virtual UIDRef GetHitLockedItemAdornment(IControlView * layoutView, PMPoint mouse, bool16 onlySelectedItems=kFalse) = 0;

 virtual UIDRef GetHitLinkedItemAdornment(IControlView * layoutView, PMPoint mouse) = 0;

 virtual UIDRef GetHitMissingFontFormItemAdornment(IControlView * layoutView, PMPoint mouse) = 0;
 
 virtual void TogglePresentationMode(IDocumentPresentation &documentPresentation) = 0;

 virtual void SetPresentationBackgroundColor(int32 stockColor, IDocumentPresentation& documentPresentation) = 0;

 virtual void HandlePresentationHideCursor() = 0;

 virtual void StartCursorHideTimer() = 0;

 virtual void StopCursorHideTimer() = 0;


 //virtual void DoSWFPreview(ISWFPreviewPreferences::SWFPreviewType const previewMode) = 0;

#ifdef DEBUG 
 virtual void CmdUIObjectCheck( const PMString &offender ) = 0;
 virtual void SetQueryUIObjectOK( bool16 bOK ) = 0;
 virtual bool16 IsQueryUIObjectOK() const = 0;
#endif 

 virtual void InvalidateAllDocumentViews() = 0;

 typedef enum
 {
 kMixed,
 kURL,
 kFile,
 kEmail,
 kBookmark,
 kPage,
 kShared,
 kParagraph,
 kUnknownDestinationType
 } DestinationSelectionType;

 virtual DestinationSelectionType GetDestinationSelectionTypeWithDest(IHyperlinkDestination * dest, bool16 isExternal) = 0;

 virtual const UID GetCurrentVisiblePage() = 0;
 
 virtual void InvalidateShapeGraphixCache(IDocument* iDoc) = 0;

 virtual void InvalidateShapeGraphixCache(IShape* iShape) = 0;

 virtual void AddNewPageAfterSpecifiedPage(const UID pageUID) = 0;
 
 virtual bool16 IsAcceleratedDrawing(IPMUnknown* layoutView) const = 0;

 virtual RealAGMColor GetPasteboardBorderColor(IControlView* view) const = 0;

 virtual RealAGMColor GetDocumentBorderColor(IControlView* view) const = 0;

};

#endif // __ILayoutUIUtils__