Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreTextGlyphRun.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_TEXT_GLYPH_RUN__
8 #define __HDI_CORE_TEXT_GLYPH_RUN__
9 
10 #include "hdicoreTypes.h"
11 
12 namespace hdi
13 {
14  namespace plugin
15  {
16  class TextGlyphRun;
17  }
18 
19  namespace core
20  {
21  class ArtboardPoint;
22  class Font;
23  class TextCharFeatures;
24  class TextLine;
25 
27  {
28  public:
38  TextGlyphRun();
39 
47  TextGlyphRun(const TextGlyphRun& gr_);
48 
54  virtual ~TextGlyphRun();
55 
61  virtual TextGlyphRun& operator=(const TextGlyphRun& rhs_);
62 
71  virtual bool operator==(const TextGlyphRun& rhs_) const;
72 
81  virtual bool operator!=(const TextGlyphRun& rhs_) const;
82 
94  virtual std::auto_ptr<ATE::IGlyphRun> ateGlyphRun() const;
95 
103  virtual bool isEmpty() const;
104 
112  virtual std::auto_ptr<TextLine> textLine() const;
113 
124  virtual int32_t glyphCount() const;
125 
133  virtual int32_t charCount() const;
134 
142  virtual int32_t originsCount() const;
143 
153  virtual bool origin(const int32_t index_, ArtboardPoint& pt__) const;
154 
162  virtual int32_t glyphIDCount() const;
163 
173  virtual bool glyphID(const int32_t index_, int32_t& id__) const;
174 
187  virtual std::auto_ptr<TextCharFeatures> charFeatures() const;
188 
196  virtual GlyphOrientation glyphOrientation() const;
197 
205  virtual double ascent() const;
206 
214  virtual double descent() const;
215 
223  virtual double tracking() const;
224 
232  virtual double spaceGlyphWidth() const;
233 
241  virtual double distToBaseline() const;
242 
250  virtual double underlinePosition() const;
251 
259  virtual double underlineThickness() const;
260 
268  virtual double minCapHeight() const;
269 
277  virtual double maxCapHeight() const;
278 
287  virtual std::auto_ptr<Font> flattenedFont() const;
288 
302  virtual std::string contents(const std::string& le_ = "\n") const;
303 
304 
305  private:
306  friend plugin::TextGlyphRun* __accessImpl(const TextGlyphRun&);
307  friend TextGlyphRun __accessCtor(const plugin::TextGlyphRun&);
308 
312  plugin::TextGlyphRun* __impl;
313 
319  TextGlyphRun(const plugin::TextGlyphRun&);
320  };
321 
322  typedef std::auto_ptr<TextGlyphRun> TextGlyphRunAP;
323 
324  extern plugin::TextGlyphRun* __accessImpl(const TextGlyphRun&);
325  extern TextGlyphRun __accessCtor(const plugin::TextGlyphRun&);
326  }
327 }
328 
329 #endif
330 // __HDI_CORE_TEXT_CHAR_STYLE__
virtual double maxCapHeight() const
Retrieves the maximum height for capital letters in the font for this run.
virtual double descent() const
Retrieves the descent of this run.
virtual bool isEmpty() const
Gets whether the target TextGlyphRun object is empty.
virtual double underlineThickness() const
Retrieves the underline thickness in the font for this run.
TextGlyphRun()
Creates a new TextGlyphRun object.
virtual double minCapHeight() const
Retrieves the minimum height for capital letters in the font for this run.
virtual std::auto_ptr< Font > flattenedFont() const
Retrieves the component font for this run if the character-feature font is a composite font...
virtual std::auto_ptr< TextCharFeatures > charFeatures() const
Retrieves the character features of this run.
virtual bool origin(const int32_t index_, ArtboardPoint &pt__) const
Retrieves an origin point for a glyph in this run.
virtual double ascent() const
Retrieves the ascent of this run.
virtual double spaceGlyphWidth() const
Retrieves the width of the space glyph in the font for this run.
virtual bool operator!=(const TextGlyphRun &rhs_) const
Tests whether a given TextGlyphRun object is not the same as another.
virtual bool operator==(const TextGlyphRun &rhs_) const
Tests whether a given TextGlyphRun object is the same as another.
virtual int32_t charCount() const
Retrieves the number of characters in this run.
virtual GlyphOrientation glyphOrientation() const
Retrieves the glyph orientation of this run.
virtual TextGlyphRun & operator=(const TextGlyphRun &rhs_)
Overloaded assignment operator for TextGlyphRun objects.
virtual std::string contents(const std::string &le_="\n") const
Gets the value (contents) of the glyph run.
virtual std::auto_ptr< ATE::IGlyphRun > ateGlyphRun() const
Gets the ATE glyph run ref around which the target object is wrapped.
virtual std::auto_ptr< TextLine > textLine() const
Retrieves the text-line parent of this glyph run.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
virtual int32_t glyphIDCount() const
Retrieves the count of glyph identifiers in this run.
Definition: hdicoreaiArray.h:12
virtual int32_t originsCount() const
Retrieves the count of origin points in this run.
virtual bool glyphID(const int32_t index_, int32_t &id__) const
Retrieves a glyph identifier for a glyph in this run.
virtual double underlinePosition() const
Retrieves the underline position in the font for this run.
virtual double tracking() const
Retrieves the tracking (space between each character) of this run.
virtual ~TextGlyphRun()
Destructs a TextGlyphRun object.
Definition: hdicoreTextGlyphRun.h:26
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:28
virtual double distToBaseline() const
Retrieves the distance to the baseline in the font for this run.
virtual int32_t glyphCount() const
Retrieves the number of glyphs in this run.