Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextStory.h
Go to the documentation of this file.
1
6
7#ifndef __HDI_CORE_TEXT_STORY__
8#define __HDI_CORE_TEXT_STORY__
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 TextStory;
21 }
22
23 namespace core
24 {
25 class TextArt;
26 class TextPara;
27 class TextRange;
28 class TextRangeSet;
29 class TextStorySet;
30 class TextWord;
31
36 {
37 public:
38 typedef std::vector< std::shared_ptr<TextArt> > TextArtVector;
39 typedef std::vector< std::shared_ptr<TextPara> > TextParaVector;
40 typedef std::vector< std::shared_ptr<TextRange> > TextRangeVector;
41 typedef std::vector< std::shared_ptr<TextWord> > TextWordVector;
42
53
61 TextStory(const TextStory& s_);
62
68 virtual ~TextStory();
69
78 virtual TextStory& operator=(const TextStory& rhs_);
79
88 virtual bool operator==(const TextStory& rhs_) const;
89
98 virtual bool operator!=(const TextStory& rhs_) const;
99
111 virtual std::unique_ptr<ATE::IStory> ateStory() const;
112
120 virtual bool isEmpty() const;
121
129 virtual std::unique_ptr<TextStory> duplicate();
130
138 virtual int32_t index() const;
139
147 virtual int32_t charCount() const;
148
156 virtual std::unique_ptr<TextRange> textRange() const;
157
169 virtual std::unique_ptr<TextRange> textRange(const int32_t start_, const int32_t end_) const;
170
178 virtual std::unique_ptr<TextRangeSet> selections() const;
179
187 virtual std::unique_ptr<TextStorySet> stories() const;
188
196 virtual TextArtVector textFrames() const;
197
205 virtual TextParaVector paragraphs() const;
206
214 virtual TextWordVector words() const;
215
223 virtual TextRangeVector runs() const;
224
233 virtual std::unique_ptr<TextArt> textFrame(const int32_t index_) const;
234
245 virtual bool kerningForRange(const TextRange& range_, AutoKernType& type__, int32_t& kerning__) const;
246
255 virtual void setAutoKerningForRange(const TextRange& range_, const AutoKernType type_);
256
267 virtual bool kerningForChar(const int32_t index_, AutoKernType& type__, int32_t& kerning__) const;
268
277 virtual void setKerningForChar(const int32_t index_, const int32_t kerning_);
278
287 virtual void suspendReflow();
288
294 virtual void resumeReflow();
295
296
297 private:
298 friend aip::TextStory* __accessImpl(const TextStory&);
299 friend TextStory __accessCtor(const aip::TextStory&);
300
304 aip::TextStory* __impl;
305
311 TextStory(const aip::TextStory&);
312 };
313
314 typedef std::unique_ptr<TextStory> TextStoryUP;
315 typedef std::shared_ptr<TextStory> TextStorySP;
316 typedef std::weak_ptr<TextStory> TextStoryWP;
317
318 extern aip::TextStory* __accessImpl(const TextStory&);
319 extern TextStory __accessCtor(const aip::TextStory&);
320 }
321}
322
323#endif
324// HDI_CORE_AIP_MODE
325
326#endif
327// __HDI_CORE_TEXT_STORY__
Allows for text frame manipulation, selection, metadata access, etc.
Definition hdicoreTextArt.h:29
Encapsulates text paragraph functionality from the Illustrator SDK.
Definition hdicoreTextPara.h:34
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
virtual TextStory & operator=(const TextStory &rhs_)
Overloaded assignment operator for TextStory objects.
virtual TextArtVector textFrames() const
Retrieves a vector of text frames contained in the target story.
virtual TextRangeVector runs() const
Retrieves a vector of runs contained in the target story.
virtual void setKerningForChar(const int32_t index_, const int32_t kerning_)
Sets a specific kern value in the target story.
virtual std::unique_ptr< TextRange > textRange(const int32_t start_, const int32_t end_) const
Retrieves an arbitrary text range from this story.
virtual bool operator!=(const TextStory &rhs_) const
Tests whether a given TextStory object is not the same as another.
virtual void resumeReflow()
Resumes normal reflow calculation after a call to suspendReflow()
virtual std::unique_ptr< TextArt > textFrame(const int32_t index_) const
Retrieves a specific text frame from the target story.
virtual bool operator==(const TextStory &rhs_) const
Tests whether a given TextStory object is the same as another.
virtual ~TextStory()
Destructs a TextStory object.
virtual std::unique_ptr< ATE::IStory > ateStory() const
Gets the ATE story ref around which the target object is wrapped.
virtual std::unique_ptr< TextStory > duplicate()
Duplicates the target object.
virtual std::unique_ptr< TextRangeSet > selections() const
Retrieves the set of text ranges that contains the selected text of the target story.
virtual int32_t index() const
Retrieves the index position of the target story in its collection.
virtual TextWordVector words() const
Retrieves a vector of words contained in the target story.
virtual void suspendReflow()
Suspends reflow calculation for the target story. Speeds up calls that cause reflow,...
TextStory()
Creates a new TextStory object.
virtual bool kerningForRange(const TextRange &range_, AutoKernType &type__, int32_t &kerning__) const
Retrieves the kerning type and value for a text range in the target story.
virtual void setAutoKerningForRange(const TextRange &range_, const AutoKernType type_)
Sets automatic or optical kerning for a text range in the target story.
virtual bool isEmpty() const
Gets whether the target TextStory object is empty.
virtual int32_t charCount() const
Retrieves the number of characters in the target story.
virtual bool kerningForChar(const int32_t index_, AutoKernType &type__, int32_t &kerning__) const
Retrieves the kerning type and value for a character in the target story.
virtual TextParaVector paragraphs() const
Retrieves a vector of paragraphs contained in the target story.
virtual std::unique_ptr< TextRange > textRange() const
Retrieves the text range that contains the entire text of the target story.
TextStory(const TextStory &s_)
TextStory copy constructor.
virtual std::unique_ptr< TextStorySet > stories() const
Retrieves the story collection that contains the target story.
Encapsulates story set functionality from the Illustrator SDK.
Definition hdicoreTextStorySet.h:35
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.
AutoKernType
Indicates the kerning type of some text.
Definition hdicoreTypes.h:495