Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreTextPara.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_TEXT_PARA__
8 #define __HDI_CORE_TEXT_PARA__
9 
10 #include <vector>
11 
12 #include "hdicoreTypes.h"
13 
14 namespace hdi
15 {
16  namespace plugin
17  {
18  class TextPara;
19  }
20 
21  namespace core
22  {
23  class TextRange;
24  class TextRangeSet;
25  class TextStory;
26  class TextWord;
27 
28  class TextPara
29  {
30  public:
31  typedef std::vector< TextWord* > TextWordVector;
32 
42  TextPara();
43 
51  TextPara(const TextPara& p_);
52 
58  virtual ~TextPara();
59 
65  virtual TextPara& operator=(const TextPara& rhs_);
66 
75  virtual bool operator==(const TextPara& rhs_) const;
76 
85  virtual bool operator!=(const TextPara& rhs_) const;
86 
98  virtual std::auto_ptr<ATE::IParagraph> ateParagraph() const;
99 
107  virtual bool isEmpty() const;
108 
116  virtual int32_t length() const;
117 
125  virtual std::auto_ptr<TextStory> story() const;
126 
134  virtual std::auto_ptr<TextRange> textRange() const;
135 
143  virtual std::auto_ptr<TextRangeSet> textRangeSet() const;
144 
152  virtual std::auto_ptr<TextRangeSet> selections() const;
153 
163  virtual TextWordVector words() const;
164 
178  virtual std::string contents(const std::string& le_ = "\n");
179 
180 
181  private:
182  friend plugin::TextPara* __accessImpl(const TextPara&);
183  friend TextPara __accessCtor(const plugin::TextPara&);
184 
188  plugin::TextPara* __impl;
189 
195  TextPara(const plugin::TextPara&);
196  };
197 
198  typedef std::auto_ptr<TextPara> TextParaAP;
199 
200  extern plugin::TextPara* __accessImpl(const TextPara&);
201  extern TextPara __accessCtor(const plugin::TextPara&);
202  }
203 }
204 
205 #endif
206 // __HDI_CORE_TEXT_PARA__
virtual TextPara & operator=(const TextPara &rhs_)
Overloaded assignment operator for TextPara objects.
virtual std::auto_ptr< TextRangeSet > selections() const
Retrieves the text selection in this paragraph.
TextPara()
Creates a new TextPara object.
virtual std::auto_ptr< TextStory > story() const
Retrieves the story that contains this paragraph.
Definition: hdicoreTextPara.h:28
virtual std::auto_ptr< TextRangeSet > textRangeSet() const
Retrieves the set of text ranges corresponding to this paragraph.
virtual bool isEmpty() const
Gets whether the target TextPara object is empty.
virtual bool operator==(const TextPara &rhs_) const
Tests whether a given TextPara object is the same as another.
virtual std::auto_ptr< TextRange > textRange() const
Retrieves the text range corresponding to this paragraph.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
virtual bool operator!=(const TextPara &rhs_) const
Tests whether a given TextPara object is not the same as another.
Definition: hdicoreaiArray.h:12
virtual int32_t length() const
Retrieves the length of this paragraph.
virtual ~TextPara()
Destructs a TextPara object.
virtual std::string contents(const std::string &le_="\n")
Gets the value (contents) of the text range.
virtual TextWordVector words() const
Retrieves a vector of the words in this paragraph.
virtual std::auto_ptr< ATE::IParagraph > ateParagraph() const
Gets the ATE paragraph ref around which the target object is wrapped.