Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextGlyphRun.h
Go to the documentation of this file.
1
6
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
32 {
33 public:
44
53
59 virtual ~TextGlyphRun();
60
69 virtual TextGlyphRun& operator=(const TextGlyphRun& rhs_);
70
79 virtual bool operator==(const TextGlyphRun& rhs_) const;
80
89 virtual bool operator!=(const TextGlyphRun& rhs_) const;
90
102 virtual std::unique_ptr<ATE::IGlyphRun> ateGlyphRun() const;
103
111 virtual bool isEmpty() const;
112
120 virtual std::unique_ptr<TextLine> textLine() const;
121
132 virtual int32_t glyphCount() const;
133
141 virtual int32_t charCount() const;
142
150 virtual int32_t originsCount() const;
151
161 virtual bool origin(const int32_t index_, ArtboardPoint& pt__) const;
162
170 virtual int32_t glyphIDCount() const;
171
181 virtual bool glyphID(const int32_t index_, int32_t& id__) const;
182
195 virtual std::unique_ptr<TextCharFeatures> charFeatures() const;
196
205
213 virtual double ascent() const;
214
222 virtual double descent() const;
223
231 virtual double tracking() const;
232
240 virtual double spaceGlyphWidth() const;
241
249 virtual double distToBaseline() const;
250
258 virtual double underlinePosition() const;
259
267 virtual double underlineThickness() const;
268
276 virtual double minCapHeight() const;
277
285 virtual double maxCapHeight() const;
286
295 virtual std::unique_ptr<Font> flattenedFont() const;
296
310 virtual std::string contents(const std::string& le_ = "\n") const;
311
312
313 private:
314 friend aip::TextGlyphRun* __accessImpl(const TextGlyphRun&);
315 friend TextGlyphRun __accessCtor(const aip::TextGlyphRun&);
316
320 aip::TextGlyphRun* __impl;
321
327 TextGlyphRun(const aip::TextGlyphRun&);
328 };
329
330 typedef std::unique_ptr<TextGlyphRun> TextGlyphRunUP;
331 typedef std::shared_ptr<TextGlyphRun> TextGlyphRunSP;
332 typedef std::weak_ptr<TextGlyphRun> TextGlyphRunWP;
333
334 extern aip::TextGlyphRun* __accessImpl(const TextGlyphRun&);
335 extern TextGlyphRun __accessCtor(const aip::TextGlyphRun&);
336 }
337}
338
339#endif
340// HDI_CORE_AIP_MODE
341
342#endif
343// __HDI_CORE_TEXT_CHAR_STYLE__
Describes a point on the Illustrator artboard.
Definition hdicoreArtboardPoint.h:31
Font class to allow for easy font manipulation.
Definition hdicoreFont.h:183
Allows for easy manipulation of Illustrator text character features.
Definition hdicoreTextCharFeatures.h:34
Encapsulates glyph run functionality from the Illustrator SDK.
Definition hdicoreTextGlyphRun.h:32
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.
Encapsulates text line functionality from the Illustrator SDK.
Definition hdicoreTextLine.h:34
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