InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IWaxIterator.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: zwilliam
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 __IWaxIterator__
25 #define __IWaxIterator__
26 
27 #include "UIDRef.h"
28 
29 class IWaxLine;
30 
31 #ifdef PUBLIC_BUILD
32 #endif
33 
41 class IWaxIterator
42 {
43 public:
44  virtual ~IWaxIterator();
45 
50  virtual UIDRef GetStrandIterating() const = 0;
51 
60  virtual IWaxLine * GetFirstWaxLine(TextIndex start, int32 * pOffset = nil) = 0;
61 
70  virtual const IWaxLine * GetFirstWaxLine(TextIndex start, int32 * pOffset = nil) const = 0;
71 
75  virtual IWaxLine * GetNextWaxLine() = 0;
76 
80  virtual const IWaxLine * GetNextWaxLine() const = 0;
81 
85  virtual IWaxLine * GetPreviousWaxLine() = 0;
86 
90  virtual const IWaxLine * GetPreviousWaxLine() const = 0;
91 
96  virtual void ClearCurrentLine() const = 0;
97 
101  virtual IWaxLine* GetCurrentWaxLine() = 0;
102 
106  virtual const IWaxLine* GetCurrentWaxLine() const = 0;
107 
111  virtual TextIndex GetCurrentWaxLineOrigin() const = 0;
112 
116  virtual int32 GetCurrentWaxLineSpan() const = 0;
117 
121  virtual TextIndex GetCurrentWaxLineEnd() const = 0;
122 
123 };
124 #endif