ITextEditorUtils.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 __ITextEditorUtils__
#define __ITextEditorUtils__

#include "Utils.h"
#include "RangeData.h"
#include "ICursorMgr.h"
#include "TextEditorID.h" // default IID

class CursorSpec;
class IControlView;
class IDialog;
class ITextModel;
class ITextParcelList;
class ITextSelectionAdornment;
class ITextStoryThread;
class ParcelKey;
class ITextVariableTable;
class PMString;
class ICharacterAlternatesData;

class ITextEditorUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTEDITORUTILS };

 virtual void GetIBeamCursor(const PMMatrix& innerToPBMatrix, CursorSpec& spec) = 0;

 virtual CursorSpec GetPointerCursorForTextTool(const SysPoint currentPt, IControlView* view, ICursorMgr::eCursorModifierState modifiers, CursorSpec defaultCursor) = 0;

 virtual PMReal HitTestStoryThread(ITextStoryThread* storyThread, ParcelKey key, IControlView* view, const PMPoint &viewLoc, TextIndex *nextLine) = 0;

 virtual RangeData AdjustHitTestTextIndex(ITextStoryThread* storyThread, IControlView* view, PMReal& charHit, const TextIndex nextLine, bool16* useCharHitForParagraphSnap = nil) = 0;

 virtual RangeData PrepareToConvertToDisplay(ITextModel *model, IControlView *view, TextIndex hitIndex, RangeData rangeToConvert) = 0;

 virtual ErrorCode ManageVariables(ITextVariableTable* varTable, const PMString* varName) = 0;

 virtual bool16 ActivateTextEditorView(IControlView* view,
 const UIDRef& splineRef) const = 0;

 virtual const ITextSelectionAdornment* GetTextSelectionAdornment() const = 0;

 virtual IDialog* ShowCharacterAlternatesUI(const PMPoint& globalPt, const char* classForLogs) const = 0;

 virtual bool16 IsCharacterAlternatesUIShown() const = 0;

 virtual IControlView* GetCharacterAlternatesView() const = 0;

 virtual void CloseCharacterAlternatesUI() const = 0;

 virtual bool16 ShouldShowCharacterAlternatesUI(bool16 &isWordSelection, TextIndex &indexOfFirstCharWithAlt) const = 0;

 virtual ErrorCode FillWithPlaceHolderText(ITextModel* model) const = 0;

 virtual ErrorCode DeletePlaceHolderText(ITextModel* pModel, bool16 &deleted) const = 0;

 virtual void InsertAlternateForSelection(const ICharacterAlternatesData *alternatesData, const int32 &index) const = 0;
 
 virtual void ShowOpenTypeIcon()const = 0;
};

#endif // __ITextEditorUtils__