IGalleyUtils.h

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

#include "WritingModeID2.h"
#include "IFontMgr.h"

class IPanelControlData;
class IControlView;
class IDocumentPresentation;
class IFontInstance;
class IDocument;
class IGraphicsContext;
class IGraphicsPort;
class RealAGMColor;
class ITextModel;
class ITextLines;
class IDrawingStyle;

namespace InDesign{ class TextRange;}
class ITextTarget;
class ILayoutTarget;
class ITableTarget;
class IViewColorScheme;

#include "IPMUnknown.h"
#include "UIDList.h"
#include "ITextDataValidation.h"
#include "IInCopyViewPrefs.h"
#include "K2Vector.h"
#include "RangeData.h"
#include "Utils.h"

class IGalleyUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IGALLEYUTILS };

 virtual IControlView *GetWritingWidget(IPanelControlData *panelData, UIDRef storyRef) = 0;

 virtual UIDRef GetStoryRef(IControlView *writingWidget) = 0;

 virtual UIDRef GetFrameRef(IControlView *writingWidget) = 0;

 virtual int32 GetStoryIndex(ITextLines* textLines, ITextModel* textModel) = 0;

 virtual IControlView *FindGalleyView(IDocument *document) = 0;

 virtual void MeasureText(IFontInstance *fontInstance, const PMString& data, PMReal* xWidth, PMReal* yWidth) = 0;

 //virtual IWindow *FindFrontmostGalleyWindow( IDocument *document = nil ) = 0;
 virtual IDocumentPresentation *FindFrontmostGalleyPresentation( IDocument *document = nil ) = 0;

 //virtual IWindow *FindFrontmostLayoutWindow( IDocument *document = nil ) = 0;
 virtual IDocumentPresentation *FindFrontmostLayoutPresentation( IDocument *document = nil ) = 0;

 virtual UIDList GetGalleyPanels( UIDRef onDocRef = UIDRef() ) = 0;

 virtual PMString GetFontOfStyle(PMString fontFamilyName, IFontMgr::FontStyleBits fontStyle) = 0;

 virtual IPMFont* QueryInterfaceFont(bool16 hilite) = 0;

 virtual void DrawInterfaceString(const PMString& string, IControlView *drawInView, IGraphicsPort* gPort, const PMRect& textBounds,
 const PMPoint& textLoc, const RealAGMColor& textColor,
 const RealAGMColor& backgroundColor, bool16 hilite = kFalse) = 0;
 
 virtual void GetXMeasureUnitList(K2Vector<ClassID>& unitList) = 0;

 virtual ITextDataValidation::RangeError ParseLineRange(K2Vector<int32>& rangeList, PMString rangeText, int32 start, int32 end) =0;


 virtual void GetFontName(PMString &fontName, PMString &fontFamilyName, PMString &style) = 0;


 virtual void GetFontStyleList(K2Vector<PMString>& StyleList, PMString &fontFamily) = 0;
 

 virtual void GetFontNameList(K2Vector<PMString>& fontList, bool16 filterSymbolFonts = kTrue, K2Vector<PMString> *translatedFontList = nil) = 0;


 virtual void GetFontFamilyAndStyle(PMString &fontName, PMString &fontFamily, PMString &fontStyle) = 0;

 virtual bool16 InGalleyOrStory ( IDocumentPresentation* pres = nil ) = 0;

 virtual bool16 InGalley ( IDocumentPresentation* pres = nil ) = 0;

 virtual bool16 InStory ( IDocumentPresentation* pres = nil ) = 0;

 virtual bool16 InLayout ( IDocumentPresentation* pres = nil ) = 0;

 //virtual IInCopyViewPrefs::ActiveView GetDocWindowView ( IWindow* window = nil ) = 0;
 virtual IInCopyViewPrefs::ActiveView GetViewMode ( IDocumentPresentation* pres = nil ) = 0;

 //virtual void SetDocWindowView ( IWindow* window, IInCopyViewPrefs::ActiveView viewMode ) = 0;
 virtual void SetViewMode ( IDocumentPresentation* pres, IInCopyViewPrefs::ActiveView viewMode ) = 0;


 virtual void SetGalleyTextSelection(TextIndex nStart, TextIndex nEnd, UIDRef storyRef, IControlView *forView = nil, bool16 ownedItemAllowed = kFalse) = 0;

 virtual void SetLayoutTextSelection(TextIndex nStart, TextIndex nEnd, UIDRef storyRef, bool16 ownedItemAllowed = kFalse) = 0;

 virtual void GetCurrentTextSelection(TextIndex& nStart, TextIndex& nEnd, UIDRef* storyRef, IControlView *view = nil) = 0;


 virtual void GetListOfUserStories(IDocument *document, UIDList &stories, bool16 stripGraphicStories = kFalse) = 0;


 virtual bool16 IsStoryCollapsedInGalley(const UIDRef &storyRef) = 0;
 

 virtual void GetNonCollapsedStoryList(IDocumentPresentation * pres, UIDList &storyList) = 0;
 

 virtual PMString GetPageNumberString(TextIndex pageNumberCharIndex, ITextModel *model) = 0;
 

 virtual int32 GetTrueOversetLineLength(ITextModel *model, TextIndex startModelOffset, int32 averageLineLength, 
 int32 primarySpan, bool16 &endsInForceBreak) = 0;

 virtual int32 EstimateOversetLineLengths(ITextModel *model) = 0;

 virtual bool16 IsBreakCharacter(const UTF32TextChar &character, bool16 &forceBreak, 
 IDrawingStyle *drawStyle = nil, ITextModel *model = nil, TextIndex position = 0L) = 0;
 
 virtual void RefreshAllText(IControlView* writingView, bool16 justInval, bool16 ignoreILE, bool16 backgroundCompose = kFalse) = 0;
 
 
 virtual void InvalInfoColumn(IControlView* writingView) = 0;

 virtual bool16 SuspendPlayPendingInvals(IDocumentPresentation* pres = nil) = 0;

 virtual bool16 ResumePlayPendingInvals(IDocumentPresentation* pres = nil) = 0;

 virtual bool16 SuspendPlayPendingInvals(UIDRef viewRef = UIDRef::gNull) = 0;

 virtual bool16 ResumePlayPendingInvals(UIDRef viewRef = UIDRef::gNull) = 0;

 virtual void CorrectFakedSpaceWidth(const UTF32TextChar &character, PMReal ptSize, IFontInstance *fontInstance, PMReal &charWidth) = 0;

 virtual void ScrollToCursor(IControlView *writingView, bool16 forceScroll = kFalse) = 0;

 virtual void GetInCopyStoriesForGalley(IDocument *theDoc, UIDList& filteredStories, bool16 stripGraphicStories) = 0;

 virtual bool16 WriteStoryListFile(const UIDRef &docRef) = 0;
 
 virtual bool16 ReadStoryListFile(const UIDRef &docRef) = 0;

 virtual std::string GetFontOfStyleAsStdStr(PMString fontFamilyName, IFontMgr::FontStyleBits fontStyle) = 0;

 virtual void GetFontNameAsStdStr(std::string &fontName, PMString &fontFamilyName, PMString &style) = 0;

 
 virtual void AttachSpecialContainerToFrames(IDocument* doc, ITextModel* textModel) = 0;
};

#endif // __IGALLEYUTILS__