InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFindChangeOptions.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Wai Cheuk
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __IFindChangeOptions__
25 #define __IFindChangeOptions__
26 
27 #ifndef __IPMUnknown__
28 #include "IPMUnknown.h"
29 #endif
30 
31 #include "ITextWalker.h"
32 #include "WideString.h"
33 #include "TextWalkerServiceProviderID.h"
34 #include "IWalkerScopeFactoryUtils.h"
35 #include "CTextEnum.h"
36 
37 class AttributeBossList;
38 class ITextAttrFont;
39 class ITextAttrUID;
40 
41 // Note: Overset Text control user interface is removed from Find/Change panel.
42 // Its functionality always includes overset text.
43 // Wai 5/5/98
44 
48 class IFindChangeOptions : public IPMUnknown
49 {
50 public:
54  enum { kDefaultIID = IID_IFINDCHANGEOPTIONS };
55 
59  enum SearchMode
60  {
62  kTextSearch,
64  kGrepSearch,
66  kGlyphSearch,
68  kObjectSearch,
70  kTransliterateSearch,
72  kColorSearch
73  };
74 
78  enum ChangeMode
79  {
81  kChange,
83  kTransliterate
84  };
85 
89  enum CharacterType
90  {
92  kKanji,
94  kHalfWidthKatakana,
96  kHalfWidthRoman,
98  kFullWidthHiragana,
100  kFullWidthKatakana,
102  kFullWidthRoman,
104  kNone,
105  kWesternArabicDigits,
106  kArabicIndicDigits,
107  kFarsiDigits
108  } ;
109 
113  enum ObjectType
114  {
116  kAllFrames,
118  kTextFrames,
120  kGraphicFrames,
122  kUnassignedFrames
123  };
124 
128  enum ChangeConditionsMode
129  {
131  kChangeReplacesConditions,
133  kChangeAddsConditions
134  };
135 
139  enum SearchDirection
140  {
141  kForward,
142  kBackward
143  };
144 
153  virtual bool16 GetCaseSensitive(SearchMode mode) const = 0;
154 
162  virtual void SetCaseSensitive(bool16 caseSensitive,SearchMode mode) = 0;
163 
172  virtual bool16 GetKanaSensitive(SearchMode mode) const = 0;
173 
181  virtual void SetKanaSensitive(bool16 kanaSensitive,SearchMode mode) = 0;
182 
192  virtual bool16 GetWidthSensitive(SearchMode mode) const = 0;
193 
201  virtual void SetWidthSensitive(bool16 widthSensitive,SearchMode mode) = 0;
202 
209  virtual IFindChangeOptions::SearchMode GetSearchMode() const = 0;
210 
217  virtual void SetSearchMode(IFindChangeOptions::SearchMode mode) = 0;
218 
225  virtual IFindChangeOptions::ChangeMode GetChangeMode() const = 0;
226 
233  virtual void SetChangeMode(IFindChangeOptions::ChangeMode changeMode) = 0;
234 
242  virtual void SetFindCharacterType(IFindChangeOptions::CharacterType charType) = 0;
243 
251  virtual IFindChangeOptions::CharacterType GetFindCharacterType() const = 0;
252 
261  virtual bool16 GetIncludeLockedStoriesForFind(SearchMode mode) const = 0;
262 
271  virtual void SetIncludeLockedStoriesForFind(bool16 includeLockedStories,SearchMode mode) = 0;
272 
281  virtual bool16 GetIncludeLockedLayersForFind(SearchMode mode) const = 0;
282 
291  virtual void SetIncludeLockedLayersForFind(bool16 includeLockedLayers,SearchMode mode) = 0;
292 
301  virtual bool16 GetIncludeHiddenLayers(SearchMode mode) const = 0;
302 
311  virtual void SetIncludeHiddenLayers(bool16 includeHiddenLayers,SearchMode mode) = 0;
312 
321  virtual bool16 GetIncludeMasterPages(SearchMode mode) const = 0;
322 
331  virtual void SetIncludeMasterPages(bool16 includeMasterPages, SearchMode mode) = 0;
332 
340  virtual bool16 GetIncludeFootnotes(SearchMode mode) const = 0;
341 
350  virtual void SetIncludeFootnotes(bool16 includeFootnotes,SearchMode mode) = 0;
351 
359  virtual bool16 GetSearchBackwards(SearchMode mode) const = 0;
360 
369  virtual void SetSearchBackwards(bool16 searchBackwards,SearchMode mode) = 0;
370 
377  virtual void SetReplaceCharacterType(IFindChangeOptions::CharacterType charType) = 0;
378 
385  virtual IFindChangeOptions::CharacterType GetReplaceCharacterType() const = 0;
386 
394  virtual bool16 GetEntireWord(SearchMode mode) const = 0;
395 
403  virtual void SetEntireWord(bool16 entireWord,SearchMode mode) = 0;
404 
413  virtual IWalkerScopeFactoryUtils::WalkScopeType GetFindChangeScope(SearchMode mode) const = 0;
414 
423  virtual void SetFindChangeScope(IWalkerScopeFactoryUtils::WalkScopeType findChangeScope,SearchMode mode) = 0;
424 
432  virtual const WideString& GetFindString(SearchMode mode) const = 0;
433 
441  virtual void SetFindString(const WideString& findString,SearchMode mode) = 0;
442 
450  virtual const WideString& GetReplaceString(SearchMode mode) const = 0;
451 
459  virtual void SetReplaceString(const WideString& replaceString,SearchMode mode) = 0;
460 
469  virtual const AttributeBossList* GetFindAttributeBossList( IDataBase *targetDB ,SearchMode mode) const = 0;
470 
479  virtual void ApplyToFindAttributeBossList(const AttributeBossList* findList, IDataBase *targetDB,SearchMode mode) = 0;
480 
487  virtual void RemoveFindAttribute(ClassID removeAttribute,SearchMode mode) = 0;
488 
494  virtual void ClearFindAttributeBossList(SearchMode mode) = 0;
495 
505  virtual const AttributeBossList* GetChangeAttributeBossList(IDataBase *targetDB, SearchMode mode, bool16 allowCreation = kTrue) const = 0;
506 
515  virtual void ApplyToChangeAttributeBossList(const AttributeBossList* findList, IDataBase *targetDB, SearchMode mode) = 0;
516 
523  virtual void RemoveChangeAttribute(ClassID removeAttribute,SearchMode mode) = 0;
524 
530  virtual void ClearChangeAttributeBossList(SearchMode mode) = 0;
531 
537  virtual void ClearFindCharStyle(SearchMode mode) = 0;
538 
544  virtual void ClearFindParaStyle(SearchMode mode) = 0;
545 
549  virtual void ClearObjectFindStyle() = 0;
550 
556  virtual void ClearChangeCharStyle(SearchMode mode) = 0;
557 
563  virtual void ClearChangeParaStyle(SearchMode mode) = 0;
564 
568  virtual void ClearObjectChangeStyle() = 0;
569 
578  virtual void SetFindCharStyle(const UID& s, IDataBase *targetDB, SearchMode mode) = 0;
579 
588  virtual void SetFindParaStyle(const UID& s, IDataBase *targetDB, SearchMode mode) = 0;
589 
596  virtual void SetObjectFindStyle(const UID& s, IDataBase *targetDB) = 0;
597 
606  virtual void SetChangeCharStyle(const UID& s, IDataBase *targetDB, SearchMode mode) = 0;
607 
616  virtual void SetChangeParaStyle(const UID& s, IDataBase *targetDB, SearchMode mode) = 0;
617 
624  virtual void SetObjectChangeStyle(const UID& s, IDataBase *targetDB) = 0;
625 
634  virtual const UID& GetFindCharStyle( IDataBase *targetDB, SearchMode mode) const = 0;
635 
644  virtual const UID& GetFindParaStyle( IDataBase *targetDB, SearchMode mode) const = 0;
645 
652  virtual const UID& GetObjectFindStyle( IDataBase *targetDB) const = 0;
653 
662  virtual const UID& GetChangeCharStyle( IDataBase *targetDB, SearchMode mode, bool16 allowCreation = kTrue) const = 0;
663 
672  virtual const UID& GetChangeParaStyle( IDataBase *targetDB, SearchMode mode, bool16 allowCreation = kTrue) const = 0;
673 
681  virtual const UID& GetObjectChangeStyle( IDataBase *targetDB, bool16 allowCreation = kFalse) const = 0;
682 
698  virtual bool16 IsThereSomethingToFind(IDataBase *targetDB, SearchMode mode) const = 0 ;
699 
706  virtual IDataBase * GetUIDAttrDB() const = 0;
707 
711  virtual void Init( bool16 caseSensitive,
712  bool16 entireWord,
713  bool16 kanaSensitive,
714  bool16 widthSensitive,
715  SearchMode searchMode,
716  ChangeMode changeMode,
717  CharacterType findCharacterType,
718  CharacterType replaceCharacterType,
719  IWalkerScopeFactoryUtils::WalkScopeType findChangeScope,
720  const WideString &findString,
721  const WideString &replaceString,
722  const AttributeBossList *findAttributeBossList,
723  const AttributeBossList *changeAttributeBossList,
724  IDataBase *targetDB,
725  const UID &findCharStyle,
726  const UID &findParaStyle,
727  const UID &changeCharStyle,
728  const UID &changeParaStyle,
729  bool16 grepFlag,
730  bool16 includeMasterPages,
731  bool16 includeLockedLayersForFind,
732  bool16 includeLockedStoriesForFind,
733  bool16 includeHiddenLayers,
734  bool16 includeFootnotes,
735  bool16 searchBackwards,
736  Text::GlyphID findGlyphID,
737  Text::GlyphID replaceGlyphID) = 0;
738 
742  virtual void Clear() = 0;
743 
750  virtual bool16 GetGrepFlag() const = 0;
751 
757  virtual void SetGrepFlag(bool16 grepFlag) = 0;
758 
766  virtual void SetChangeXMLTag(const PMString& tagName,SearchMode mode) = 0;
767 
775  virtual const PMString& GetChangeXMLTag(SearchMode mode) const = 0;
776 
782  virtual void ClearChangeXMLTag(SearchMode mode) = 0;
783 
791  virtual void SetChangeCaseOption(const PMString& caseOption,SearchMode mode) = 0;
792 
800  virtual const PMString& GetChangeCaseOption(SearchMode mode) const = 0;
801 
807  virtual void ClearChangeCaseOption(SearchMode mode) = 0;
808 
816  virtual const Text::GlyphID GetFindGlyphID() const = 0;
817 
823  virtual void SetFindGlyphID(const Text::GlyphID findGlyphID) = 0;
824 
830  virtual void SetFindROSFontGroup(const PMString& registry,const PMString& ordering) = 0;
831 
837  virtual void GetFindROSFontGroup(PMString& registry,PMString& ordering) const = 0;
838 
843  virtual void SetUseFindROSFontGroup(const bool16 bUseROSFontGroup) = 0;
844 
849  virtual const bool16 GetUseFindROSFontGroup() const = 0;
850 
857  virtual const Text::GlyphID GetReplaceGlyphID() const = 0;
858 
864  virtual void SetReplaceGlyphID(const Text::GlyphID replaceGlyphID) = 0;
865 
871  virtual void SetReplaceROSFontGroup(const PMString& registry,const PMString& ordering) = 0;
872 
878  virtual void GetReplaceROSFontGroup(PMString& registry,PMString& ordering) const = 0;
879 
884  virtual void SetUseReplaceROSFontGroup(const bool16 bUseROSFontGroup) = 0;
885 
890  virtual const bool16 GetUseReplaceROSFontGroup() const = 0;
891 
898  virtual void SetObjectSearchType(const ObjectType objType) = 0;
899 
906  virtual const ObjectType GetObjectSearchType() const = 0;
907 
916  virtual void SetChangeConditionsMode(ChangeConditionsMode chgConditionsMode, SearchMode mode) = 0;
917 
926  virtual IFindChangeOptions::ChangeConditionsMode GetChangeConditionsMode(SearchMode mode) const = 0;
927 
933  virtual void ClearChangeConditionsMode(SearchMode mode) = 0;
934 
935  /*
936  Internal use. Do not call.
937  This is called by the Find-Change startup service to initialize database of attributes.
938  */
939  virtual void InitializeDB() = 0;
940 
941 };
942 
943 #endif