Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextStorySet.h
Go to the documentation of this file.
1
6
7#ifndef __HDI_CORE_TEXT_STORY_SET__
8#define __HDI_CORE_TEXT_STORY_SET__
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 TextStorySet;
21 }
22
23 namespace core
24 {
25 class TextPara;
26 class TextRange;
27 class TextRangeSet;
28 class TextStory;
29 class TextWord;
30
35 {
36 public:
37 typedef std::vector< std::shared_ptr<TextPara> > TextParaVector;
38 typedef std::vector< std::shared_ptr<TextRange> > TextRangeVector;
39 typedef std::vector< std::shared_ptr<TextWord> > TextWordVector;
40
51
60
66 virtual ~TextStorySet();
67
76 virtual TextStorySet& operator=(const TextStorySet& rhs_);
77
86 virtual bool operator==(const TextStorySet& rhs_) const;
87
96 virtual bool operator!=(const TextStorySet& rhs_) const;
97
109 virtual std::unique_ptr<ATE::IStories> ateStorySet() const;
110
118 virtual bool isEmpty() const;
119
127 virtual int32_t size() const;
128
138 virtual bool hasFocus() const;
139
147 virtual std::unique_ptr<TextStory> focusedStory() const;
148
156 virtual void setFocusedStory(const TextStory& story_);
157
163 virtual void loseFocus();
164
172 virtual std::unique_ptr<TextRangeSet> textRanges() const;
173
181 virtual std::unique_ptr<TextRangeSet> selections() const;
182
190 virtual TextParaVector paragraphs() const;
191
199 virtual TextWordVector words() const;
200
208 virtual TextRangeVector runs() const;
209
218 virtual std::unique_ptr<TextStory> story(const int32_t index_) const;
219
228 virtual void suspendReflow();
229
235 virtual void resumeReflow();
236
237
238 private:
239 friend aip::TextStorySet* __accessImpl(const TextStorySet&);
240 friend TextStorySet __accessCtor(const aip::TextStorySet&);
241
245 aip::TextStorySet* __impl;
246
252 TextStorySet(const aip::TextStorySet&);
253 };
254
255 typedef std::unique_ptr<TextStorySet> TextStorySetUP;
256 typedef std::shared_ptr<TextStorySet> TextStorySetSP;
257 typedef std::weak_ptr<TextStorySet> TextStorySetWP;
258
259 extern aip::TextStorySet* __accessImpl(const TextStorySet&);
260 extern TextStorySet __accessCtor(const aip::TextStorySet&);
261 }
262}
263
264#endif
265// HDI_CORE_AIP_MODE
266
267#endif
268// __HDI_CORE_TEXT_STORY_SET__
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
Encapsulates story set functionality from the Illustrator SDK.
Definition hdicoreTextStorySet.h:35
virtual bool operator==(const TextStorySet &rhs_) const
Tests whether a given TextStorySet object is the same as another.
virtual TextWordVector words() const
Retrieves a vector of words contained by the member stories.
virtual void resumeReflow()
Resumes normal reflow calculation after a call to suspendReflow()
virtual std::unique_ptr< TextStory > story(const int32_t index_) const
Retrieves a member of this set by position index.
virtual void loseFocus()
Removes input focus from the story currently being edited, deselecting everything in the document.
virtual bool isEmpty() const
Gets whether the target TextStorySet object is empty.
virtual void setFocusedStory(const TextStory &story_)
Sets the input focus to a member story, deselecting everything in the document.
virtual std::unique_ptr< ATE::IStories > ateStorySet() const
Gets the ATE story set ref around which the target object is wrapped.
virtual ~TextStorySet()
Destructs a TextStorySet object.
TextStorySet()
Creates a new TextStorySet object.
virtual bool operator!=(const TextStorySet &rhs_) const
Tests whether a given TextStorySet object is not the same as another.
virtual int32_t size() const
Retrieves the number of members of this set.
virtual std::unique_ptr< TextStory > focusedStory() const
Retrieves the member story that has input focus.
virtual std::unique_ptr< TextRangeSet > selections() const
Retrieves the set of text ranges for selected text in these stories.
virtual void suspendReflow()
Suspends reflow calculation for the target stories. Speeds up calls that cause reflow,...
virtual std::unique_ptr< TextRangeSet > textRanges() const
Retrieves the set of text ranges in these stories.
virtual TextRangeVector runs() const
Retrieves a vector of runs (ranges) contained by the member stories.
virtual TextStorySet & operator=(const TextStorySet &rhs_)
Overloaded assignment operator for TextStorySet objects.
TextStorySet(const TextStorySet &ss_)
TextStorySet copy constructor.
virtual bool hasFocus() const
Reports whether a member story has the input focus.
virtual TextParaVector paragraphs() const
Retrieves a vector of paragraphs contained by the member stories.
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.