hdi::core::TextTabStopSet Class Reference

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

#include <hdicoreTextTabStopSet.h>

Classes
class	Iterator
	Allows for iteration through the children of a tab stop set, a la std::vector iteration. More...

Public Types
typedef std::unique_ptr< Iterator >	IteratorUP
typedef std::shared_ptr< Iterator >	IteratorSP
typedef std::weak_ptr< Iterator >	IteratorWP

Public Member Functions
	TextTabStopSet ()
	Creates a new TextTabStopSet object.
	TextTabStopSet (const TextTabStopSet &tss_)
	TextTabStopSet copy constructor.
virtual	~TextTabStopSet ()
	Destructs a TextTabStopSet object.
virtual TextTabStopSet &	operator= (const TextTabStopSet &rhs_)
	Overloaded assignment operator for TextTabStopSet objects.
virtual bool	operator== (const TextTabStopSet &rhs_) const
	Tests whether a given TextTabStopSet object is the same as another.
virtual bool	operator!= (const TextTabStopSet &rhs_) const
	Tests whether a given TextTabStopSet object is not the same as another.
virtual std::unique_ptr< ATE::ITabStops >	ateTabStopSet () const
	Gets the ATE tab stop set ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextTabStopSet object is empty.
virtual int32_t	size () const
	Retrieves the number of members of the target set.
virtual Iterator	begin () const
	Gets an iterator for the set.
virtual void	replaceOrAdd (const TextTabStop &ts_)
	Replaces or adds a tab stop to the target set.
virtual std::unique_ptr< TextTabStop >	tabStop (const int32_t index_) const
	Retrieves a member of the target set by position index.
virtual void	remove (const int32_t index_)
	Removes a member from the set.
virtual void	removeAll ()
	Removes all members from the set.

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

Detailed Description

Encapsulates tab stop set functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextTabStopSet() [1/2]

hdi::core::TextTabStopSet::TextTabStopSet

(

)

Creates a new TextTabStopSet object.

Author

GW

Date

08/2014

Note

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

TextTabStopSet() [2/2]

hdi::core::TextTabStopSet::TextTabStopSet

(

const TextTabStopSet &

tss_

)

TextTabStopSet copy constructor.

Author

GW

Date

08/2014

Parameters

tss_	TextTabStopSet object to copy values from

~TextTabStopSet()

virtual hdi::core::TextTabStopSet::~TextTabStopSet ( )

virtual

Destructs a TextTabStopSet object.

Author

GW

Date

08/2014

Member Function Documentation

ateTabStopSet()

virtual std::unique_ptr< ATE::ITabStops > hdi::core::TextTabStopSet::ateTabStopSet ( ) const

virtual

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

Author

GW

Date

08/2014

Returns

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

begin()

virtual Iterator hdi::core::TextTabStopSet::begin ( ) const

virtual

Gets an iterator for the set.

Author

GW

Date

08/2014

Returns

An Iterator object, for iterating through the target's children

// Here's an example, iterating through the children of someSet:
for(hdi::core::TextTabStopSet::Iterator iter = someSet.begin(); !iter.atEnd(); ++iter)
{
    // do stuff to iter.tabStop()
}

isEmpty()

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

virtual

Gets whether the target TextTabStopSet object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextTabStopSet object is empty, false otherwise

Note

A TextTabStopSet object being empty is not the same as it having a size of 0.

operator!=()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

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

operator=()

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

virtual

Overloaded assignment operator for TextTabStopSet objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextTabStopSet object to copy values from

Returns

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

operator==()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

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

remove()

virtual void hdi::core::TextTabStopSet::remove ( const int32_t index_ )

virtual

Removes a member from the set.

Author

GW

Date

08/2014

Parameters

index_

The 0-based position index of the member to remove

removeAll()

virtual void hdi::core::TextTabStopSet::removeAll ( )

virtual

Removes all members from the set.

Author

GW

Date

08/2014

replaceOrAdd()

virtual void hdi::core::TextTabStopSet::replaceOrAdd ( const TextTabStop & ts_ )

virtual

Replaces or adds a tab stop to the target set.

Author

GW

Date

08/2014

Parameters

ts_	The replacement or new tab stop object

size()

virtual int32_t hdi::core::TextTabStopSet::size ( ) const

virtual

Retrieves the number of members of the target set.

Author

GW

Date

08/2014

Returns

The number of members, or -1 is isEmpty() returns true

tabStop()

virtual std::unique_ptr< TextTabStop > hdi::core::TextTabStopSet::tabStop ( const int32_t index_ ) const

virtual

Retrieves a member of the target set by position index.

Author

GW

Date

08/2014

Parameters

index_

The 0-based position index

Returns

The tab stop member object