Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextArt.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_TEXT_ART__
8#define __HDI_CORE_TEXT_ART__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include <vector>
13
14#include "hdicoreTypes.h"
15
16namespace hdi
17{
18 namespace core
19 {
20 class Art;
21 class TextLine;
22 class TextRange;
23 class TextStory;
24
28 class TextArt
29 {
30 public:
31 typedef std::vector< std::shared_ptr<TextLine> > TextLineVector;
32
33 enum Type
34 {
35 UnknownType = 0,
36 PointTextType = 10,
37 InPathTextType = 20,
38 OnPathTextType = 30
39 };
40
41 enum LineOrientation
42 {
43 UnknownLineOrientation = 0,
44 HorizLineOrientation = 10,
45 VertL2RLineOrientation = 20, // Not used by Illustrator
46 VertR2LLineOrientation = 30
47 };
48
55
67 std::unique_ptr<ATE::ITextFrame> ateTextFrame() const;
68
76 std::unique_ptr<TextStory> parentStory() const;
77
85 std::unique_ptr<TextRange> textRange() const;
86
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 void* __data;
271
275 bool __cleanup;
276
282 TextArt();
283
291 TextArt(void* const art_);
292
298 TextArt(const TextArt&);
299
305 TextArt& operator=(const TextArt&);
306 };
307
308 typedef std::unique_ptr<TextArt> TextArtUP;
309 typedef std::shared_ptr<TextArt> TextArtSP;
310 typedef std::weak_ptr<TextArt> TextArtWP;
311 }
312}
313
314#endif
315// HDI_CORE_AIP_MODE
316
317#endif
318// __HDI_CORE_TEXT_ART__
Handles general art-related functionality.
Definition: hdicoreArt.h:51
Allows for text frame manipulation, selection, metadata access, etc.
Definition: hdicoreTextArt.h:29
int32_t rowCount() const
Retrieves the number of rows for the target text frame.
double columnGutter() const
Retrieves the column gutter value for the target text frame.
bool rowMajorOrder() const
Reports whether the text range is arranged in row-major order.
~TextArt()
Destructs a TextArt object.
TextLineVector textLines() const
Retrieves a text-line vector with which you can access the text lines of the target text frame.
std::unique_ptr< ATE::ITextFrame > ateTextFrame() const
Gets the ATE text frame ref around which the target object is wrapped.
void setRowCount(const int32_t count_)
Sets the number of rows for the target text frame.
double spacing() const
Retrieves the line spacing value for the target text frame.
void setOpticalAlignment(const bool active_)
Turns optical alignment on or off for the target text frame.
void setColumnGutter(const double gutter_)
Sets the column gutter value for the target text frame.
bool selected() const
Reports whether the target frame is selected.
double rowGutter() const
Retrieves the row gutter value for the target text frame.
void setRowGutter(const double gutter_)
Sets the row gutter value for the target text frame.
void setLineOrientation(const LineOrientation orientation_)
Sets the line orientation value for the target text frame.
LineOrientation lineOrientation() const
Retrieves the line orientation of the target text frame.
void setColumnCount(const int32_t count_)
Sets the number of columns for the target text frame.
std::unique_ptr< TextStory > parentStory() const
Retrieves the parent story of the target text frame.
std::unique_ptr< TextRange > textRange() const
Retrieves the text range of the target frame.
void setSpacing(const double spacing_)
Sets the line spacing value for the target text frame.
int32_t columnCount() const
Retrieves the number of columns for the target text frame.
Type frameType() const
Retrieves the type of the target text 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.
Definition: hdicoreTextLine.h:31
Allows for easy manipulation of Illustrator text ranges.
Definition: hdicoreTextRange.h:41
Definition: hdicoreTextStory.h:33
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.