Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextPara.h
Go to the documentation of this file.
1
6
7#ifndef __HDI_CORE_TEXT_PARA__
8#define __HDI_CORE_TEXT_PARA__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include <vector>
13
14#include "hdicoreTypes.h"
15
16namespace hdi
17{
18 namespace aip
19 {
20 class TextPara;
21 }
22
23 namespace core
24 {
25 class TextRange;
26 class TextRangeSet;
27 class TextStory;
28 class TextWord;
29
34 {
35 public:
36 typedef std::vector< std::shared_ptr<TextWord> > TextWordVector;
37
48
56 TextPara(const TextPara& p_);
57
63 virtual ~TextPara();
64
73 virtual TextPara& operator=(const TextPara& rhs_);
74
83 virtual bool operator==(const TextPara& rhs_) const;
84
93 virtual bool operator!=(const TextPara& rhs_) const;
94
106 virtual std::unique_ptr<ATE::IParagraph> ateParagraph() const;
107
115 virtual bool isEmpty() const;
116
124 virtual int32_t length() const;
125
133 virtual std::unique_ptr<TextStory> story() const;
134
142 virtual std::unique_ptr<TextRange> textRange() const;
143
151 virtual std::unique_ptr<TextRangeSet> textRangeSet() const;
152
160 virtual std::unique_ptr<TextRangeSet> selections() const;
161
169 virtual TextWordVector words() const;
170
184 virtual std::string contents(const std::string& le_ = "\n");
185
186
187 private:
188 friend aip::TextPara* __accessImpl(const TextPara&);
189 friend TextPara __accessCtor(const aip::TextPara&);
190
194 aip::TextPara* __impl;
195
201 TextPara(const aip::TextPara&);
202 };
203
204 typedef std::unique_ptr<TextPara> TextParaUP;
205 typedef std::shared_ptr<TextPara> TextParaSP;
206 typedef std::weak_ptr<TextPara> TextParaWP;
207
208 extern aip::TextPara* __accessImpl(const TextPara&);
209 extern TextPara __accessCtor(const aip::TextPara&);
210 }
211}
212
213#endif
214// HDI_CORE_AIP_MODE
215
216#endif
217// __HDI_CORE_TEXT_PARA__
Encapsulates text paragraph functionality from the Illustrator SDK.
Definition hdicoreTextPara.h:34
virtual int32_t length() const
Retrieves the length of this paragraph.
TextPara(const TextPara &p_)
TextPara copy constructor.
virtual TextPara & operator=(const TextPara &rhs_)
Overloaded assignment operator for TextPara objects.
TextPara()
Creates a new TextPara object.
virtual std::string contents(const std::string &le_="\n")
Gets the value (contents) of the text range.
virtual std::unique_ptr< ATE::IParagraph > ateParagraph() const
Gets the ATE paragraph ref around which the target object is wrapped.
virtual std::unique_ptr< TextRangeSet > textRangeSet() const
Retrieves the set of text ranges corresponding to this paragraph.
virtual bool operator!=(const TextPara &rhs_) const
Tests whether a given TextPara object is not the same as another.
virtual std::unique_ptr< TextRangeSet > selections() const
Retrieves the text selection in this paragraph.
virtual bool operator==(const TextPara &rhs_) const
Tests whether a given TextPara object is the same as another.
virtual TextWordVector words() const
Retrieves a vector of the words in this paragraph.
virtual bool isEmpty() const
Gets whether the target TextPara object is empty.
virtual std::unique_ptr< TextRange > textRange() const
Retrieves the text range corresponding to this paragraph.
virtual std::unique_ptr< TextStory > story() const
Retrieves the story that contains this paragraph.
virtual ~TextPara()
Destructs a TextPara object.
Allows for easy manipulation of Illustrator text ranges.
Definition hdicoreTextRange.h:41
Encapsulates text range set functionality from the Illustrator SDK.
Definition hdicoreTextRangeSet.h:37
Encapsulates story functionality from the Illustrator SDK.
Definition hdicoreTextStory.h:36
Encapsulates text word functionality from the Illustrator SDK.
Definition hdicoreTextWord.h:29
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.