IFindChangeUtils.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 __IFindChangeUtils__
#define __IFindChangeUtils__

#include "IPMUnknown.h"

#include "WideString.h"
#include "K2Vector.h"
#include "CTextEnum.h"
#include "TextWalkerServiceProviderID.h"

class IFindChangeOptions;
class ITextModel;
class AttributeBossList;
class PMString;

const Text::GlyphID kAnyNotDefGlyphID = -2;

class IFindChangeUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFINDCHANGEUTILS };

 virtual void FindThisItem(const ITextModel* pModel, const WideString& findString,
 TextIndex nPosition, TextIndex nEnd,
 TextIndex& nFoundStart, TextIndex& nFoundEnd,
 const IFindChangeOptions* pFindChangeOptions,
 int32 allWildCardCount ) const = 0;


 virtual bool16 SearchForGlyph(const ITextModel *pModel,
 const IFindChangeOptions* option,
 Text::GlyphID value,
 TextIndex findStart,
 TextIndex findEnd,
 TextIndex& nFoundStart,
 TextIndex& nFoundEnd) const = 0;

 virtual bool16 SearchForGrepText(const ITextModel *pModel,
 bool16 caseSensitive,
 bool16 widthSensitive,
 bool16 kanaSensitive,
 bool16 getEntireWord,
 const WideString &findString,
 TextIndex nPosition,
 TextIndex nEnd,
 TextIndex& nFoundStart,
 TextIndex& nFoundEnd,
 bool16 nestedStyles = kFalse,
 bool16 searchBackwards = kFalse) const = 0;

 virtual bool16 SearchForRawText(const ITextModel *pModel,
 bool16 caseSensitive,
 bool16 widthSensitive,
 bool16 kanaSensitive,
 bool16 getEntireWord,
 const WideString &findString,
 TextIndex nPosition,
 TextIndex nEnd,
 TextIndex& nFoundStart,
 TextIndex& nFoundEnd,
 const bool16 diacritics = kFalse,
 const bool16 kashidas = kFalse,
 bool16 searchBackwards = kFalse) const = 0;

 virtual bool16 SearchForCharStyle(const ITextModel* pModel, const UID& charStyleUID,
 TextIndex nFindStart, TextIndex nFindEnd,
 TextIndex& nFoundStart, TextIndex& nFoundEnd,
 bool16 searchBackwards = kFalse) const = 0;
 virtual bool16 SearchForParaStyle(const ITextModel* pModel, const UID& paraStyleUID,
 TextIndex nFindStart, TextIndex nFindEnd,
 TextIndex& nFoundStart, TextIndex& nFoundEnd,
 bool16 searchBackwards = kFalse) const = 0;
 virtual bool16 SearchForAttributes(const ITextModel* pModel, const AttributeBossList* list,
 TextIndex nFindStart, TextIndex nFindEnd,
 TextIndex& nFoundStart, TextIndex& nFoundEnd,
 bool16 searchBackwards = kFalse) const = 0;

 virtual bool16 SearchForROSFontGroup(const ITextModel* pModel, const AttributeBossList* list,
 const PMString& registry, const PMString& ordering,
 TextIndex nFindStart, TextIndex nFindEnd,
 TextIndex& nFoundStart, TextIndex& nFoundEnd,
 bool16 searchBackwards = kFalse) const = 0;

 virtual int32 SearchForAccessPath(const ITextModel *model,
 K2Vector<WideString>& accessPaths,
 TextIndex nFindStart,
 TextIndex nFindEnd,
 TextIndex& nFoundStart,
 TextIndex& nFoundEnd,
 bool16 searchBackwards = kFalse) const = 0;

 virtual void UnescapeGrepFindString(const WideString& inStr, WideString& out, bool16 ignoreWidth = kFalse) const = 0;

};


#endif
 // __IFindChangeUtils__