INoteDataUtils.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 __INOTEDATAUTILS__
#define __INOTEDATAUTILS__

#include "NoteID.h"
#include "INoteDataUtils.h"
#include "IPMUnknown.h"
#include "UIDList.h"
#include "RangeData.h"
#include "ITextModel.h"
//#include "INoteMarkerRange.h"

//-----------------------------------
// Forward References
//
class INoteChangePrefs;
class WideString;
class IDocument;
class IControlView;
class ITextLines;
class ITextRuns;

class INoteDataUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_INOTEDATAUTILS };
 enum Note_Type { kBookEnd, kNoteContent, kHitTestStoryText, kHitDeletedText };
 
 virtual int32 GetPageNumberOfTextIndex(TextIndex anchorPos, ITextModel* textModel, PMString * pageString = nil) = 0;
 
 virtual void GetNoteNumber(UIDRef storyRef, UID noteDataUID, int32& currentNoteNumber) const = 0;
 

 virtual int32 GetStoryNoteCount(UIDRef storyRef, int32& totalStoryNoteCount) const = 0;
 
 virtual int32 CountWords(ITextModel* textModel, TextIndex begin, TextIndex end, int32 *charCount = nil) = 0;
 

 virtual bool16 IsWordBreak(const UTF32TextChar& currChar) = 0;
 
 virtual bool16 IsPunctuation(const UTF32TextChar& currChar) = 0;

 virtual UIDRef NewNote(TextIndex createAt, UIDRef storyRef, UIDRef docRef) = 0;

 virtual int32 GetNoteColorIndex(UIDRef docRef, const WideString& userName) const = 0;

 virtual int32 GetNoteColorIndex(IDataBase* docDataBase, const WideString& userName) const = 0;


 virtual int32 GetNoteBGColorIndex(UIDRef docRef, const WideString& userName) const = 0;

 virtual int32 GetNoteBGColorIndex(IDataBase* docDataBase, const WideString& userName) const = 0;

 virtual bool16 DetectInlineNoteData(IControlView* writingView, const SysPoint globalPoint, 
 bool16* bIsCollapsed, int16* typeFound, 
 int32* originalStoryIndex, int32* activeStoryIndex,
 int32* pLineIndex = 0, int32* pOffsetIntoLine = 0) const = 0;

 virtual bool16 IsNoteOwnedItem(ClassID id) = 0;
 
 virtual void SetupOwnedItemInfo(UIDRef textModelRef, TextIndex textIndex, ClassID ownedItemClass, UID ownedItemUID) = 0;
};

#endif // __INOTEDATAUTILS__