Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Types | Public Member Functions | Friends | List of all members
hdi::core::TextArt Class Reference

Allows for text frame manipulation, selection, metadata access, etc. More...

#include <hdicoreTextArt.h>

Public Types

enum  Type { UnknownType = 0, PointTextType = 10, InPathTextType = 20, OnPathTextType = 30 }
 
enum  LineOrientation { UnknownLineOrientation = 0, HorizLineOrientation = 10, VertL2RLineOrientation = 20, VertR2LLineOrientation = 30 }
 
typedef std::vector< TextLine * > TextLineVector
 

Public Member Functions

 ~TextArt ()
 Destructs a TextArt object. More...
 
std::auto_ptr< ATE::ITextFrame > ateTextFrame () const
 Gets the ATE text frame ref around which the target object is wrapped. More...
 
std::auto_ptr< TextStoryparentStory () const
 Retrieves the parent story of the target text frame. More...
 
std::auto_ptr< TextRangetextRange () const
 Retrieves the text range of the target frame. More...
 
TextLineVector textLines () const
 Retrieves a text-line vector with which you can access the text lines of the target text frame. More...
 
Type frameType () const
 Retrieves the type of the target text frame. More...
 
bool selected () const
 Reports whether the target frame is selected. More...
 
LineOrientation lineOrientation () const
 Retrieves the line orientation of the target text frame. More...
 
void setLineOrientation (const LineOrientation orientation_)
 Sets the line orientation value for the target text frame. More...
 
int32_t rowCount () const
 Retrieves the number of rows for the target text frame. More...
 
void setRowCount (const int32_t count_)
 Sets the number of rows for the target text frame. More...
 
int32_t columnCount () const
 Retrieves the number of columns for the target text frame. More...
 
void setColumnCount (const int32_t count_)
 Sets the number of columns for the target text frame. More...
 
bool rowMajorOrder () const
 Reports whether the text range is arranged in row-major order. More...
 
void setRowMajorOrder (const bool isMajor_)
 Turns row-major order on or off for the target text frame. More...
 
double rowGutter () const
 Retrieves the row gutter value for the target text frame. More...
 
void setRowGutter (const double gutter_)
 Sets the row gutter value for the target text frame. More...
 
double columnGutter () const
 Retrieves the column gutter value for the target text frame. More...
 
void setColumnGutter (const double gutter_)
 Sets the column gutter value for the target text frame. More...
 
double spacing () const
 Retrieves the line spacing value for the target text frame. More...
 
void setSpacing (const double spacing_)
 Sets the line spacing value for the target text frame. More...
 
bool opticalAlignment () const
 Reports whether optical alignment is on for the target text frame. More...
 
void setOpticalAlignment (const bool active_)
 Turns optical alignment on or off for the target text frame. More...
 

Friends

class Art
 
class TextLine
 
class TextRange
 
class TextStory
 

Detailed Description

Allows for text frame manipulation, selection, metadata access, etc.

Constructor & Destructor Documentation

hdi::core::TextArt::~TextArt ( )

Destructs a TextArt object.

Author
GW
Date
08/2013

Member Function Documentation

std::auto_ptr<ATE::ITextFrame> hdi::core::TextArt::ateTextFrame ( ) const

Gets the ATE text frame ref around which the target object is wrapped.

Author
GW
Date
08/2014
Returns
ATE::ITextFrame for the target object
Note
Generally, you shouldn't need to call this method. Only use it if you know what you're doing. If a specific piece of functionality provided by Illustrator is not handled by this class (or related classes), then it should probably be added to the hdi_core library.
int32_t hdi::core::TextArt::columnCount ( ) const

Retrieves the number of columns for the target text frame.

Author
GW
Date
12/2013
Returns
Number of frame columns
double hdi::core::TextArt::columnGutter ( ) const

Retrieves the column gutter value for the target text frame.

Author
GW
Date
12/2013
Returns
The frame's column gutter value
Type hdi::core::TextArt::frameType ( ) const

Retrieves the type of the target text frame.

Author
GW
Date
12/2013
Returns
The text frame type
LineOrientation hdi::core::TextArt::lineOrientation ( ) const

Retrieves the line orientation of the target text frame.

Author
GW
Date
12/2013
Returns
The line orientation
bool hdi::core::TextArt::opticalAlignment ( ) const

Reports whether optical alignment is on for the target text frame.

Author
GW
Date
12/2013
Returns
true if optical alignment is active, false otherwise
std::auto_ptr<TextStory> hdi::core::TextArt::parentStory ( ) const

Retrieves the parent story of the target text frame.

Author
GW
Date
12/2013
Returns
The parent story, or NULL if error
int32_t hdi::core::TextArt::rowCount ( ) const

Retrieves the number of rows for the target text frame.

Author
GW
Date
12/2013
Returns
Number of frame rows
double hdi::core::TextArt::rowGutter ( ) const

Retrieves the row gutter value for the target text frame.

Author
GW
Date
12/2013
Returns
The frame's row gutter value
bool hdi::core::TextArt::rowMajorOrder ( ) const

Reports whether the text range is arranged in row-major order.

Author
GW
Date
12/2013
Returns
true if in row-major order, false otherwise
bool hdi::core::TextArt::selected ( ) const

Reports whether the target frame is selected.

Author
GW
Date
12/2013
Returns
true if selected, false otherwise
void hdi::core::TextArt::setColumnCount ( const int32_t  count_)

Sets the number of columns for the target text frame.

Author
GW
Date
12/2013
Parameters
count_New column count
void hdi::core::TextArt::setColumnGutter ( const double  gutter_)

Sets the column gutter value for the target text frame.

Author
GW
Date
12/2013
Parameters
gutter_New column gutter value
void hdi::core::TextArt::setLineOrientation ( const LineOrientation  orientation_)

Sets the line orientation value for the target text frame.

Author
GW
Date
12/2013
Parameters
orientation_New line orientation
void hdi::core::TextArt::setOpticalAlignment ( const bool  active_)

Turns optical alignment on or off for the target text frame.

Author
GW
Date
12/2013
Parameters
active_true to activate optical alignment, false otherwise
void hdi::core::TextArt::setRowCount ( const int32_t  count_)

Sets the number of rows for the target text frame.

Author
GW
Date
12/2013
Parameters
count_New row count
void hdi::core::TextArt::setRowGutter ( const double  gutter_)

Sets the row gutter value for the target text frame.

Author
GW
Date
12/2013
Parameters
gutter_New row gutter value
void hdi::core::TextArt::setRowMajorOrder ( const bool  isMajor_)

Turns row-major order on or off for the target text frame.

Author
GW
Date
12/2013
Parameters
isMajor_true to enable row-major order, false otherwise
void hdi::core::TextArt::setSpacing ( const double  spacing_)

Sets the line spacing value for the target text frame.

Author
GW
Date
12/2013
Parameters
spacing_New line spacing value
double hdi::core::TextArt::spacing ( ) const

Retrieves the line spacing value for the target text frame.

Author
GW
Date
12/2013
Returns
The frame's line spacing value
TextLineVector hdi::core::TextArt::textLines ( ) const

Retrieves a text-line vector with which you can access the text lines of the target text frame.

Author
GW
Date
12/2013
Returns
A vector of TextLine object pointers
Warning
The caller assumes responsibility for the memory of the contained TextLine objects.
std::auto_ptr<TextRange> hdi::core::TextArt::textRange ( ) const

Retrieves the text range of the target frame.

Author
GW
Date
12/2013
Returns
The text range, or NULL if error