hdi::core::TextWord Class Reference

Encapsulates text word functionality from the Illustrator SDK. More...

#include <hdicoreTextWord.h>

Public Member Functions
	TextWord ()
	Creates a new TextWord object.
	TextWord (const TextWord &w_)
	TextWord copy constructor.
virtual	~TextWord ()
	Destructs a TextWord object.
virtual TextWord &	operator= (const TextWord &rhs_)
	Overloaded assignment operator for TextWord objects.
virtual bool	operator== (const TextWord &rhs_) const
	Tests whether a given TextWord object is the same as another.
virtual bool	operator!= (const TextWord &rhs_) const
	Tests whether a given TextWord object is not the same as another.
virtual std::unique_ptr< ATE::IWordsIterator >	ateWord () const
	Gets the ATE word ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextWord object is empty.
std::unique_ptr< TextRange >	range () const
	Retrieves the text range for the current word, including trailing characters.
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.
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.
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.

Friends
aip::TextWord *	__accessImpl (const TextWord &)
TextWord	__accessCtor (const aip::TextWord &)

Detailed Description

Encapsulates text word functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextWord() [1/2]

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.

TextWord() [2/2]

hdi::core::TextWord::TextWord

(

const TextWord &

w_

)

TextWord copy constructor.

Author

GW

Date

08/2014

Parameters

w_	TextWord object to copy values from

~TextWord()

virtual hdi::core::TextWord::~TextWord ( )

virtual

Destructs a TextWord object.

Author

GW

Date

08/2014

Member Function Documentation

ateWord()

virtual std::unique_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.

isEmpty()

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

operator!=()

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

operator=()

virtual TextWord & hdi::core::TextWord::operator= ( const TextWord & rhs_ )

virtual

Overloaded assignment operator for TextWord objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextWord object to copy values from

Returns

The target TextWord object, but with its values updated to match that of rhs_

operator==()

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

range()

std::unique_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

trailingCount()

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

trailingSpaceCount()

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

trailingTerminatingPunctuationCount()

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