Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreTextArt.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_TEXT_ART__
8 #define __HDI_CORE_TEXT_ART__
9 
10 #include <vector>
11 
12 #include "hdicoreTypes.h"
13 
14 namespace hdi
15 {
16  namespace core
17  {
18  class Art;
19  class TextLine;
20  class TextRange;
21  class TextStory;
22 
26  class TextArt
27  {
28  public:
29  typedef std::vector< TextLine* > TextLineVector;
30 
31  enum Type
32  {
33  UnknownType = 0,
34  PointTextType = 10,
35  InPathTextType = 20,
36  OnPathTextType = 30
37  };
38 
39  enum LineOrientation
40  {
41  UnknownLineOrientation = 0,
42  HorizLineOrientation = 10,
43  VertL2RLineOrientation = 20, // Not used by Illustrator
44  VertR2LLineOrientation = 30
45  };
46 
52  ~TextArt();
53 
65  std::auto_ptr<ATE::ITextFrame> ateTextFrame() const;
66 
74  std::auto_ptr<TextStory> parentStory() const;
75 
83  std::auto_ptr<TextRange> textRange() const;
84 
95  TextLineVector textLines() const;
96 
104  Type frameType() const;
105 
113  bool selected() const;
114 
122  LineOrientation lineOrientation() const;
123 
131  void setLineOrientation(const LineOrientation orientation_);
132 
140  int32_t rowCount() const;
141 
149  void setRowCount(const int32_t count_);
150 
158  int32_t columnCount() const;
159 
167  void setColumnCount(const int32_t count_);
168 
176  bool rowMajorOrder() const;
177 
185  void setRowMajorOrder(const bool isMajor_);
186 
194  double rowGutter() const;
195 
203  void setRowGutter(const double gutter_);
204 
212  double columnGutter() const;
213 
221  void setColumnGutter(const double gutter_);
222 
230  double spacing() const;
231 
239  void setSpacing(const double spacing_);
240 
248  bool opticalAlignment() const;
249 
257  void setOpticalAlignment(const bool active_);
258 
259 
260  private:
261  // Only these classes can construct a new TextArt object
262  friend class Art;
263  friend class TextLine;
264  friend class TextRange;
265  friend class TextStory;
266 
270  Art* __art;
271 
275  bool __cleanup;
276 
282  TextArt();
283 
291  TextArt(Art* const art_);
292 
298  TextArt(const TextArt&);
299 
305  TextArt& operator=(const TextArt&);
306  };
307 
308  typedef std::auto_ptr<TextArt> TextArtAP;
309  }
310 }
311 
312 #endif
313 // __HDI_CORE_TEXT_ART__
~TextArt()
Destructs a TextArt object.
void setColumnCount(const int32_t count_)
Sets the number of columns for the target text frame.
Handles general art-related functionality.
Definition: hdicoreArt.h:47
bool selected() const
Reports whether the target frame is selected.
int32_t columnCount() const
Retrieves the number of columns for the target text frame.
std::auto_ptr< TextStory > parentStory() const
Retrieves the parent story of the target text frame.
Allows for easy manipulation of Illustrator text ranges.
Definition: hdicoreTextRange.h:38
LineOrientation lineOrientation() const
Retrieves the line orientation of the target text frame.
int32_t rowCount() const
Retrieves the number of rows for the target text frame.
void setRowGutter(const double gutter_)
Sets the row gutter value for the target text frame.
std::auto_ptr< ATE::ITextFrame > ateTextFrame() const
Gets the ATE text frame ref around which the target object is wrapped.
void setLineOrientation(const LineOrientation orientation_)
Sets the line orientation value for the target text frame.
void setColumnGutter(const double gutter_)
Sets the column gutter value for the target text frame.
TextLineVector textLines() const
Retrieves a text-line vector with which you can access the text lines of the target text frame...
Definition: hdicoreTextStory.h:30
double columnGutter() const
Retrieves the column gutter value for the target text frame.
double rowGutter() const
Retrieves the row gutter value for the target text frame.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
Definition: hdicoreTextLine.h:28
Allows for text frame manipulation, selection, metadata access, etc.
Definition: hdicoreTextArt.h:26
Type frameType() const
Retrieves the type of the target text frame.
void setOpticalAlignment(const bool active_)
Turns optical alignment on or off for the target text frame.
Definition: hdicoreaiArray.h:12
std::auto_ptr< TextRange > textRange() const
Retrieves the text range of the target frame.
void setRowMajorOrder(const bool isMajor_)
Turns row-major order on or off for the target text frame.
bool opticalAlignment() const
Reports whether optical alignment is on for the target text frame.
void setRowCount(const int32_t count_)
Sets the number of rows for the target text frame.
bool rowMajorOrder() const
Reports whether the text range is arranged in row-major order.
double spacing() const
Retrieves the line spacing value for the target text frame.
void setSpacing(const double spacing_)
Sets the line spacing value for the target text frame.