Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
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 #include <vector>
11 
12 #include "hdicoreTypes.h"
13 
14 namespace hdi
15 {
16  namespace plugin
17  {
18  class TextStorySet;
19  }
20 
21  namespace core
22  {
23  class TextPara;
24  class TextRange;
25  class TextRangeSet;
26  class TextStory;
27  class TextWord;
28 
30  {
31  public:
32  typedef std::vector< TextPara* > TextParaVector;
33  typedef std::vector< TextRange* > TextRangeVector;
34  typedef std::vector< TextWord* > TextWordVector;
35 
45  TextStorySet();
46 
54  TextStorySet(const TextStorySet& ss_);
55 
61  virtual ~TextStorySet();
62 
68  virtual TextStorySet& operator=(const TextStorySet& rhs_);
69 
78  virtual bool operator==(const TextStorySet& rhs_) const;
79 
88  virtual bool operator!=(const TextStorySet& rhs_) const;
89 
101  virtual std::auto_ptr<ATE::IStories> ateStorySet() const;
102 
110  virtual bool isEmpty() const;
111 
119  virtual int32_t size() const;
120 
130  virtual bool hasFocus() const;
131 
139  virtual std::auto_ptr<TextStory> focusedStory() const;
140 
148  virtual void setFocusedStory(const TextStory& story_);
149 
155  virtual void loseFocus();
156 
164  virtual std::auto_ptr<TextRangeSet> textRanges() const;
165 
173  virtual std::auto_ptr<TextRangeSet> selections() const;
174 
184  virtual TextParaVector paragraphs() const;
185 
195  virtual TextWordVector words() const;
196 
206  virtual TextRangeVector runs() const;
207 
216  virtual std::auto_ptr<TextStory> story(const int32_t index_) const;
217 
226  virtual void suspendReflow();
227 
233  virtual void resumeReflow();
234 
235 
236  private:
237  friend plugin::TextStorySet* __accessImpl(const TextStorySet&);
238  friend TextStorySet __accessCtor(const plugin::TextStorySet&);
239 
243  plugin::TextStorySet* __impl;
244 
250  TextStorySet(const plugin::TextStorySet&);
251  };
252 
253  typedef std::auto_ptr<TextStorySet> TextStorySetAP;
254 
255  extern plugin::TextStorySet* __accessImpl(const TextStorySet&);
256  extern TextStorySet __accessCtor(const plugin::TextStorySet&);
257  }
258 }
259 
260 #endif
261 // __HDI_CORE_TEXT_STORY_SET__
virtual bool operator==(const TextStorySet &rhs_) const
Tests whether a given TextStorySet object is the same as another.
virtual void suspendReflow()
Suspends reflow calculation for the target stories. Speeds up calls that cause reflow, such as TextRange insertion methods.
virtual bool operator!=(const TextStorySet &rhs_) const
Tests whether a given TextStorySet object is not the same as another.
virtual std::auto_ptr< TextStory > story(const int32_t index_) const
Retrieves a member of this set by position index.
Definition: hdicoreTextStorySet.h:29
virtual void resumeReflow()
Resumes normal reflow calculation after a call to suspendReflow()
virtual bool isEmpty() const
Gets whether the target TextStorySet object is empty.
virtual std::auto_ptr< TextRangeSet > selections() const
Retrieves the set of text ranges for selected text in these stories.
Definition: hdicoreTextStory.h:30
virtual int32_t size() const
Retrieves the number of members of this set.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
TextStorySet()
Creates a new TextStorySet object.
virtual TextParaVector paragraphs() const
Retrieves a vector of paragraphs contained by the member stories.
virtual TextStorySet & operator=(const TextStorySet &rhs_)
Overloaded assignment operator for TextStorySet objects.
Definition: hdicoreaiArray.h:12
virtual TextWordVector words() const
Retrieves a vector of words contained by the member stories.
virtual void setFocusedStory(const TextStory &story_)
Sets the input focus to a member story, deselecting everything in the document.
virtual bool hasFocus() const
Reports whether a member story has the input focus.
virtual ~TextStorySet()
Destructs a TextStorySet object.
virtual std::auto_ptr< TextStory > focusedStory() const
Retrieves the member story that has input focus.
virtual void loseFocus()
Removes input focus from the story currently being edited, deselecting everything in the document...
virtual std::auto_ptr< ATE::IStories > ateStorySet() const
Gets the ATE story set ref around which the target object is wrapped.
virtual TextRangeVector runs() const
Retrieves a vector of runs (ranges) contained by the member stories.
virtual std::auto_ptr< TextRangeSet > textRanges() const
Retrieves the set of text ranges in these stories.