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

Public Types

typedef std::vector< TextGlyphRun * > TextGlyphRunVector
 

Public Member Functions

 TextLine ()
 Creates a new TextLine object. More...
 
 TextLine (const TextLine &tl_)
 TextLine copy constructor. More...
 
virtual ~TextLine ()
 Destructs a TextLine object. More...
 
virtual TextLineoperator= (const TextLine &rhs_)
 Overloaded assignment operator for TextLine objects. More...
 
virtual bool operator== (const TextLine &rhs_) const
 Tests whether a given TextLine object is the same as another. More...
 
virtual bool operator!= (const TextLine &rhs_) const
 Tests whether a given TextLine object is not the same as another. More...
 
virtual std::auto_ptr< ATE::ITextLine > ateTextLine () const
 Gets the ATE text line ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextLine object is empty. More...
 
virtual TextGlyphRunVector glyphRuns () const
 Retrieves all glyph-runs for the target text line. More...
 
virtual std::auto_ptr< TextArttextFrame () const
 Retrieves the parent text frame of this line. More...
 
virtual std::auto_ptr< TextRangetextRange () const
 Retrieves the text range for this line. More...
 
virtual int32_t baselineCount () const
 Retrieves the count of baselines. More...
 
virtual bool baseline (const int32_t index_, ArtboardPoint &start__, ArtboardPoint &end__) const
 Retrieves a baseline with a start and end point in the coordinate space of the containing text frame. More...
 

Friends

plugin::TextLine * __accessImpl (const TextLine &)
 
TextLine __accessCtor (const plugin::TextLine &)
 

Constructor & Destructor Documentation

hdi::core::TextLine::TextLine ( )

Creates a new TextLine object.

Author
GW
Date
08/2014
Note
New TextLine objects do not relate to any text line on the Illustrator artboard; they are designed to be "receivers" of some other TextLine object via the overloaded assignment operator or assigned to some other existent text art.
hdi::core::TextLine::TextLine ( const TextLine tl_)

TextLine copy constructor.

Author
GW
Date
08/2014
Parameters
tl_TextLine object to copy values from
virtual hdi::core::TextLine::~TextLine ( )
virtual

Destructs a TextLine object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_ptr<ATE::ITextLine> hdi::core::TextLine::ateTextLine ( ) const
virtual

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

Author
GW
Date
08/2014
Returns
ATE::ITextLineRef 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.
virtual bool hdi::core::TextLine::baseline ( const int32_t  index_,
ArtboardPoint start__,
ArtboardPoint end__ 
) const
virtual

Retrieves a baseline with a start and end point in the coordinate space of the containing text frame.

Author
GW
Date
08/2014
Parameters
index_Index of the baseline in question
start__Return-by-reference for the baseline start point
end__Return-by-reference for the baseline end point
Returns
true if the baseline could be acquired, false otherwise
virtual int32_t hdi::core::TextLine::baselineCount ( ) const
virtual

Retrieves the count of baselines.

Author
GW
Date
08/2014
Returns
The baseline count, or -1 for error
virtual TextGlyphRunVector hdi::core::TextLine::glyphRuns ( ) const
virtual

Retrieves all glyph-runs for the target text line.

Author
GW
Date
08/2014
Returns
A vector of glyph-run objects
Warning
The caller assumes responsibility for the memory of the contained TextGlyphRun objects.
virtual bool hdi::core::TextLine::isEmpty ( ) const
virtual

Gets whether the target TextLine object is empty.

Author
GW
Date
08/2014
Returns
true if the target TextLine object is empty, false otherwise
virtual bool hdi::core::TextLine::operator!= ( const TextLine rhs_) const
virtual

Tests whether a given TextLine object is not the same as another.

Author
GW
Date
08/2014
Parameters
rhs_TextLine to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different text line, false otherwise
virtual TextLine& hdi::core::TextLine::operator= ( const TextLine rhs_)
virtual

Overloaded assignment operator for TextLine objects.

Author
GW
Date
08/2014
virtual bool hdi::core::TextLine::operator== ( const TextLine rhs_) const
virtual

Tests whether a given TextLine object is the same as another.

Author
GW
Date
08/2014
Parameters
rhs_TextLine to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text line, false otherwise
virtual std::auto_ptr<TextArt> hdi::core::TextLine::textFrame ( ) const
virtual

Retrieves the parent text frame of this line.

Author
GW
Date
08/2014
Returns
The text frame object
virtual std::auto_ptr<TextRange> hdi::core::TextLine::textRange ( ) const
virtual

Retrieves the text range for this line.

Author
GW
Date
08/2014
Returns
The text range object