Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
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#if defined(HDI_CORE_AIP_MODE)
11
12#include "hdicoreTypes.h"
13
14namespace hdi
15{
16 namespace aip
17 {
18 class TextGlyphRun;
19 }
20
21 namespace core
22 {
23 class ArtboardPoint;
24 class Font;
25 class TextCharFeatures;
26 class TextLine;
27
29 {
30 public:
41
50
56 virtual ~TextGlyphRun();
57
63 virtual TextGlyphRun& operator=(const TextGlyphRun& rhs_);
64
73 virtual bool operator==(const TextGlyphRun& rhs_) const;
74
83 virtual bool operator!=(const TextGlyphRun& rhs_) const;
84
96 virtual std::unique_ptr<ATE::IGlyphRun> ateGlyphRun() const;
97
105 virtual bool isEmpty() const;
106
114 virtual std::unique_ptr<TextLine> textLine() const;
115
126 virtual int32_t glyphCount() const;
127
135 virtual int32_t charCount() const;
136
144 virtual int32_t originsCount() const;
145
155 virtual bool origin(const int32_t index_, ArtboardPoint& pt__) const;
156
164 virtual int32_t glyphIDCount() const;
165
175 virtual bool glyphID(const int32_t index_, int32_t& id__) const;
176
189 virtual std::unique_ptr<TextCharFeatures> charFeatures() const;
190
199
207 virtual double ascent() const;
208
216 virtual double descent() const;
217
225 virtual double tracking() const;
226
234 virtual double spaceGlyphWidth() const;
235
243 virtual double distToBaseline() const;
244
252 virtual double underlinePosition() const;
253
261 virtual double underlineThickness() const;
262
270 virtual double minCapHeight() const;
271
279 virtual double maxCapHeight() const;
280
289 virtual std::unique_ptr<Font> flattenedFont() const;
290
304 virtual std::string contents(const std::string& le_ = "\n") const;
305
306
307 private:
308 friend aip::TextGlyphRun* __accessImpl(const TextGlyphRun&);
309 friend TextGlyphRun __accessCtor(const aip::TextGlyphRun&);
310
314 aip::TextGlyphRun* __impl;
315
321 TextGlyphRun(const aip::TextGlyphRun&);
322 };
323
324 typedef std::unique_ptr<TextGlyphRun> TextGlyphRunUP;
325 typedef std::shared_ptr<TextGlyphRun> TextGlyphRunSP;
326 typedef std::weak_ptr<TextGlyphRun> TextGlyphRunWP;
327
328 extern aip::TextGlyphRun* __accessImpl(const TextGlyphRun&);
329 extern TextGlyphRun __accessCtor(const aip::TextGlyphRun&);
330 }
331}
332
333#endif
334// HDI_CORE_AIP_MODE
335
336#endif
337// __HDI_CORE_TEXT_CHAR_STYLE__
Describes a point on the Illustrator artboard.
Definition: hdicoreArtboardPoint.h:31
Definition: hdicoreTextGlyphRun.h:29
TextGlyphRun(const TextGlyphRun &gr_)
TextGlyphRun copy constructor.
virtual double underlineThickness() const
Retrieves the underline thickness in the font for this run.
virtual ~TextGlyphRun()
Destructs a TextGlyphRun object.
virtual double tracking() const
Retrieves the tracking (space between each character) of 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 std::unique_ptr< TextLine > textLine() const
Retrieves the text-line parent of this glyph run.
virtual int32_t originsCount() const
Retrieves the count of origin points in this run.
virtual bool operator==(const TextGlyphRun &rhs_) const
Tests whether a given TextGlyphRun object is the same as another.
virtual double minCapHeight() const
Retrieves the minimum height for capital letters in the font for this run.
virtual bool origin(const int32_t index_, ArtboardPoint &pt__) const
Retrieves an origin point for a glyph in this run.
virtual double distToBaseline() const
Retrieves the distance to the baseline in the font for this run.
TextGlyphRun()
Creates a new TextGlyphRun object.
virtual std::unique_ptr< ATE::IGlyphRun > ateGlyphRun() const
Gets the ATE glyph run ref around which the target object is wrapped.
virtual int32_t glyphIDCount() const
Retrieves the count of glyph identifiers in this run.
virtual GlyphOrientation glyphOrientation() const
Retrieves the glyph orientation of this run.
virtual int32_t glyphCount() const
Retrieves the number of glyphs 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 std::unique_ptr< TextCharFeatures > charFeatures() const
Retrieves the character features of this run.
virtual int32_t charCount() const
Retrieves the number of characters in this run.
virtual double maxCapHeight() const
Retrieves the maximum height for capital letters in the font for this run.
virtual double ascent() const
Retrieves the ascent of this run.
virtual std::unique_ptr< Font > flattenedFont() const
Retrieves the component font for this run if the character-feature font is a composite font,...
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 bool operator!=(const TextGlyphRun &rhs_) const
Tests whether a given TextGlyphRun object is not the same as another.
virtual double underlinePosition() const
Retrieves the underline position in the font for this run.
virtual double spaceGlyphWidth() const
Retrieves the width of the space glyph in the font for this run.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
GlyphOrientation
Describes the orientation of a glyph run.
Definition: hdicoreTypes.h:519