INoteUtils.h

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

#include "NoteID.h"

//-----------------------------------
// Forward References
//
class IControlView;
class IMultiColumnTextFrame;
class ITextModel;
class IWaxStrand;
class PMPoint;
class PMString;
class IDocument;
class IGalleySwitch;
class INoteStringAttribute;
class IFrameList;
class IMasterSpreadList;
class IHierarchy;
class PMRect;
class IDocumentPresentation;
class INoteData;
class WideString;
class RangeData;


#include "IPMUnknown.h"
#include "UIDList.h"

class INoteUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_INOTEUTILS };
 

 virtual void ConvertNoteTipText(const uchar16* inString, int32& inBufLength, PMString& outBuffer) = 0;

 virtual INoteData* QueryNoteData(const ITextModel* textModel, const TextIndex noteDataIndex) = 0;

 virtual INoteData* QueryNoteData(const UIDRef& noteDataRef) = 0;

 virtual INoteData* GetNoteData(ITextModel* textModel, TextIndex offset) = 0;


 virtual SysPoint GlobalToLocal(IControlView* controlView, SysPoint globalPoint) = 0;
 // Convert a SysPoint from global coordinate to a local coordinate in the
 // controlView context.


 virtual IMultiColumnTextFrame* QueryTextFrame(IControlView* controlView, 
 PMPoint where, 
 RangeData *caret, 
 bool16 composeFirst = kTrue) = 0; 

 virtual void GetTime(PMString* time) = 0;

 virtual IDocument* QueryDocument(ITextModel* model, IControlView* view) = 0;
 // Return the document with a given text model


 virtual bool16 InGalley(IGalleySwitch* galleySwitch) = 0;
 
 virtual PMPoint IndexToPMPoint(ITextModel* textModel, const RangeData &caret, int32* thisFrameIndex) = 0;

 virtual bool16 GetStoryLockState(ITextModel* textModel) = 0;

 virtual bool16 GetStoryLockState(IDocument* document) = 0;

 virtual const int32 GetDocAnchorCount(IDocument* document) = 0;

 virtual const int32 GetAnchorCount(ITextModel* textModel) = 0;

 virtual int32 ResetStoryAnchorCount(ITextModel* textModel) = 0;
 // accumulate the anchor count from the text model and return the total
 // count for this story. This is 100% accurate but performance can be an issue
 // for large story with large number of notes in it.
 
 virtual int32 ResetDocAnchorCount(IDocument* document) = 0;
 // for each story in the document, accumulate the anchor count from the text model and return the total
 // count for the document. This is 100% accurate but performance can be an issue for larger document
 // with large number of notes in it.

 virtual PMReal GetGalleyLeftIndent() = 0;
 // return the left indent of the info panel in Galley. If in layout this value will be zero.


 virtual bool16 NoteInCurrentSpread(UID noteSpreadUID, UID curSpreadUID, IMasterSpreadList* masterSpreadList) = 0;
 // check if this note window (i.e. with noteSpreadUID) should be open in the curSpreadUID.
 // return kTrue to open, otherwise return kFalse


 virtual bool16 PageItemInvisible(ITextModel* textModel, IHierarchy* hierItem) = 0;
 // This method determines if the page item in the hierarchy is in the invisible
 // layer, which is used to hold the overset text for InCopy text frame.


 virtual UID GetLastVisibleFrame(ITextModel* textModel, TextIndex startIndex) = 0;
 // !!! InCopy call only !!!
 // With a given text index, this function returns the UID of the
 // of the last visible frame.


 virtual IDocumentPresentation* GetDocWindow(IDataBase* dataBase) = 0;
 // With a given database, return the front document window (the first in the 
 // IPresentationList order). $$$ This will NOT work in the multiple views of the 
 // same document case because it gives us the first in the list. Since Note
 // is not required of InDesign, this will work fine in InCopy.


 virtual UID GetSpreadUID(ITextModel* textModel, TextIndex offset) = 0;


 virtual UID GetSpreadUID(INoteData* noteData, ITextModel* textModel, TextIndex position) = 0;

 virtual bool16 InvisibleText(ITextModel* textModel, TextIndex index) = 0;

 virtual bool16 FindNoteStoryThread(ITextModel* textModel, UID noteDataUID, TextIndex* threadStart, int32* threadSpan) = 0;

 virtual WideString GetNoteContent(ITextModel* textModel, const UIDRef& noteRef) = 0;

 virtual ErrorCode ToggleAllNoteCollapse(ITextModel* textModel, UID currentNoteUID, bool16 newCollapseState, bool16 collapseAllButOne) = 0;
 

 virtual void ClearAllNotes(IDocument* document) = 0;

 virtual void ClearAllNotes(ITextModel* textModel) = 0;

 virtual void DoDragDropNoteModel(UIDRef srcStoryRef, UIDRef targetStoryRef, TextIndex srcTextIndex, TextIndex targetTextIndex, bool16 duplicateNote, bool16 startOfDeletedText) = 0;
};

#endif // __INOTEUTILS__