hdi::core::TextTabStop Class Reference

Encapsulates tab stop functionality from the Illustrator SDK. More...

#include <hdicoreTextTabStop.h>

Public Types
enum	TabType {   UnknownTabType = 0 , LeftTabType = 10 , CenterTabType = 20 , RightTabType = 30 ,   DecimalTabType = 40 }

Public Member Functions
	TextTabStop ()
	Creates a new TextTabStop object.
	TextTabStop (const TextTabStop &ts_)
	TextTabStop copy constructor.
virtual	~TextTabStop ()
	Destructs a TextTabStop object.
virtual TextTabStop &	operator= (const TextTabStop &rhs_)
	Overloaded assignment operator for TextTabStop objects.
virtual bool	operator== (const TextTabStop &rhs_) const
	Tests whether a given TextTabStop object is the same as another.
virtual bool	operator!= (const TextTabStop &rhs_) const
	Tests whether a given TextTabStop object is not the same as another.
virtual std::unique_ptr< ATE::ITabStop >	ateTabStop () const
	Gets the ATE tab stop ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextTabStop object is empty.
virtual TabType	tabType () const
	Retrieves the type of the target's tab stop.
virtual void	setTabType (const TabType type_)
	Sets the type of the target's tab stop.
virtual double	position () const
	Retrieves the position of the target tab stop.
virtual void	setPosition (const double pos_)
	Sets the position of the target tab stop.
virtual bool	hasLeader () const
	Reports whether the target tab stop uses a leader.
virtual std::string	leader () const
	Retrieves the leader string for the target tab stop.
virtual void	setLeader (const std::string &leader_)
	Sets the leader string for the target tab stop.
virtual std::string	decimalChar () const
	Retrieves the decimal character for the target tab stop.
virtual void	setDecimalChar (const std::string &char_)
	Sets the decimal character for the target tab stop.

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

Detailed Description

Encapsulates tab stop functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextTabStop() [1/2]

hdi::core::TextTabStop::TextTabStop

(

)

Creates a new TextTabStop object.

Author

GW

Date

08/2014

Note

New TextTabStop objects do not relate to any text tab stop on the Illustrator artboard; they are designed to be "receivers" of some other TextTabStop object via the overloaded assignment operator or assigned to some other existent text art.

TextTabStop() [2/2]

hdi::core::TextTabStop::TextTabStop

(

const TextTabStop &

ts_

)

TextTabStop copy constructor.

Author

GW

Date

08/2014

Parameters

ts_	TextTabStop object to copy values from

~TextTabStop()

virtual hdi::core::TextTabStop::~TextTabStop ( )

virtual

Destructs a TextTabStop object.

Author

GW

Date

08/2014

Member Function Documentation

ateTabStop()

virtual std::unique_ptr< ATE::ITabStop > hdi::core::TextTabStop::ateTabStop ( ) const

virtual

Gets the ATE tab stop ref around which the target object is wrapped.

Author

GW

Date

08/2014

Returns

ATE::ITabStopRef 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.

decimalChar()

virtual std::string hdi::core::TextTabStop::decimalChar ( ) const

virtual

Retrieves the decimal character for the target tab stop.

Author

GW

Date

08/2014

Returns

A string containing the character, as UTF-8

hasLeader()

virtual bool hdi::core::TextTabStop::hasLeader ( ) const

virtual

Reports whether the target tab stop uses a leader.

Author

GW

Date

08/2014

Returns

true if the tab uses a leader, false otherwise

isEmpty()

virtual bool hdi::core::TextTabStop::isEmpty ( ) const

virtual

Gets whether the target TextTabStop object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextTabStop object is empty, false otherwise

leader()

virtual std::string hdi::core::TextTabStop::leader ( ) const

virtual

Retrieves the leader string for the target tab stop.

Author

GW

Date

08/2014

Returns

The leader contents, as UTF-8

operator!=()

virtual bool hdi::core::TextTabStop::operator!= ( const TextTabStop & rhs_ ) const

virtual

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

Author

GW

Date

08/2014

Parameters

rhs_	TextTabStop to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different text tab stops, false otherwise

operator=()

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

virtual

Overloaded assignment operator for TextTabStop objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextTabStop object to copy values from

Returns

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

operator==()

virtual bool hdi::core::TextTabStop::operator== ( const TextTabStop & rhs_ ) const

virtual

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

Author

GW

Date

08/2014

Parameters

rhs_	TextTabStop to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same text tab stop, false otherwise

position()

virtual double hdi::core::TextTabStop::position ( ) const

virtual

Retrieves the position of the target tab stop.

Author

GW

Date

08/2014

Returns

The tab position in document points

setDecimalChar()

virtual void hdi::core::TextTabStop::setDecimalChar ( const std::string & char_ )

virtual

Sets the decimal character for the target tab stop.

Author

GW

Date

08/2014

Parameters

char_

A string containing the character, as UTF-8

setLeader()

virtual void hdi::core::TextTabStop::setLeader ( const std::string & leader_ )

virtual

Sets the leader string for the target tab stop.

Author

GW

Date

08/2014

Parameters

leader_

The new leader content string, as UTF-8

setPosition()

virtual void hdi::core::TextTabStop::setPosition ( const double pos_ )

virtual

Sets the position of the target tab stop.

Author

GW

Date

08/2014

Parameters

pos_	The tab position in document points

setTabType()

virtual void hdi::core::TextTabStop::setTabType ( const TabType type_ )

virtual

Sets the type of the target's tab stop.

Author

GW

Date

08/2014

Parameters

type_

The tab type constant

tabType()

virtual TabType hdi::core::TextTabStop::tabType ( ) const

virtual

Retrieves the type of the target's tab stop.

Author

GW

Date

08/2014

Returns

The tab type constant