Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextStorySet.h
Go to the documentation of this file.
1
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
32 {
33 public:
34 typedef std::vector< std::shared_ptr<TextPara> > TextParaVector;
35 typedef std::vector< std::shared_ptr<TextRange> > TextRangeVector;
36 typedef std::vector< std::shared_ptr<TextWord> > TextWordVector;
37
48
57
63 virtual ~TextStorySet();
64
70 virtual TextStorySet& operator=(const TextStorySet& rhs_);
71
80 virtual bool operator==(const TextStorySet& rhs_) const;
81
90 virtual bool operator!=(const TextStorySet& rhs_) const;
91
103 virtual std::unique_ptr<ATE::IStories> ateStorySet() const;
104
112 virtual bool isEmpty() const;
113
121 virtual int32_t size() const;
122
132 virtual bool hasFocus() const;
133
141 virtual std::unique_ptr<TextStory> focusedStory() const;
142
150 virtual void setFocusedStory(const TextStory& story_);
151
157 virtual void loseFocus();
158
166 virtual std::unique_ptr<TextRangeSet> textRanges() const;
167
175 virtual std::unique_ptr<TextRangeSet> selections() const;
176
184 virtual TextParaVector paragraphs() const;
185
193 virtual TextWordVector words() const;
194
202 virtual TextRangeVector runs() const;
203
212 virtual std::unique_ptr<TextStory> story(const int32_t index_) const;
213
222 virtual void suspendReflow();
223
229 virtual void resumeReflow();
230
231
232 private:
233 friend aip::TextStorySet* __accessImpl(const TextStorySet&);
234 friend TextStorySet __accessCtor(const aip::TextStorySet&);
235
239 aip::TextStorySet* __impl;
240
246 TextStorySet(const aip::TextStorySet&);
247 };
248
249 typedef std::unique_ptr<TextStorySet> TextStorySetUP;
250 typedef std::shared_ptr<TextStorySet> TextStorySetSP;
251 typedef std::weak_ptr<TextStorySet> TextStorySetWP;
252
253 extern aip::TextStorySet* __accessImpl(const TextStorySet&);
254 extern TextStorySet __accessCtor(const aip::TextStorySet&);
255 }
256}
257
258#endif
259// HDI_CORE_AIP_MODE
260
261#endif
262// __HDI_CORE_TEXT_STORY_SET__
Definition: hdicoreTextStory.h:33
Definition: hdicoreTextStorySet.h:32
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.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.