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

Public Member Functions

 TextWord ()
 Creates a new TextWord object. More...
 
 TextWord (const TextWord &w_)
 TextWord copy constructor. More...
 
virtual ~TextWord ()
 Destructs a TextWord object. More...
 
virtual TextWordoperator= (const TextWord &rhs_)
 Overloaded assignment operator for TextWord objects. More...
 
virtual bool operator== (const TextWord &rhs_) const
 Tests whether a given TextWord object is the same as another. More...
 
virtual bool operator!= (const TextWord &rhs_) const
 Tests whether a given TextWord object is not the same as another. More...
 
virtual std::auto_ptr< ATE::IWordsIterator > ateWord () const
 Gets the ATE word ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextWord object is empty. More...
 
std::auto_ptr< TextRangerange () const
 Retrieves the text range for the current word, including trailing characters. More...
 
int32_t trailingSpaceCount () const
 Retrieves the number of trailing spaces for the current word. Trailing spaces are those after the word, regardless of the direction of iteration. More...
 
int32_t trailingCount () const
 Retrieves the total number of trailing characters for the current word, including spaces, other white-space characters, and punctuation characters. Trailing characters are those after the word, regardless of the direction of iteration. More...
 
int32_t trailingTerminatingPunctuationCount () const
 Retrieves the number of trailing punctuation characters for the current word. Trailing characters are those after the word, regardless of the direction of iteration. More...
 

Friends

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

Constructor & Destructor Documentation

hdi::core::TextWord::TextWord ( )

Creates a new TextWord object.

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

TextWord copy constructor.

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

Destructs a TextWord object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_ptr<ATE::IWordsIterator> hdi::core::TextWord::ateWord ( ) const
virtual

Gets the ATE word ref around which the target object is wrapped.

Author
GW
Date
08/2014
Returns
ATE::IWordsIteratorRef 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::TextWord::isEmpty ( ) const
virtual

Gets whether the target TextWord object is empty.

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

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

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

Overloaded assignment operator for TextWord objects.

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

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

Author
GW
Date
08/2014
Parameters
rhs_TextWord to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text word, false otherwise
std::auto_ptr<TextRange> hdi::core::TextWord::range ( ) const

Retrieves the text range for the current word, including trailing characters.

Author
GW
Date
08/2014
Returns
The text range of the target word
int32_t hdi::core::TextWord::trailingCount ( ) const

Retrieves the total number of trailing characters for the current word, including spaces, other white-space characters, and punctuation characters. Trailing characters are those after the word, regardless of the direction of iteration.

Author
GW
Date
08/2014
Returns
The number of trailing characters
int32_t hdi::core::TextWord::trailingSpaceCount ( ) const

Retrieves the number of trailing spaces for the current word. Trailing spaces are those after the word, regardless of the direction of iteration.

Author
GW
Date
08/2014
Returns
The number of trailing spaces
int32_t hdi::core::TextWord::trailingTerminatingPunctuationCount ( ) const

Retrieves the number of trailing punctuation characters for the current word. Trailing characters are those after the word, regardless of the direction of iteration.

Author
GW
Date
08/2014
Returns
The number of trailing punctuation characters