hdi::core::TextParaStyleSet Class Reference

Encapsulates paragraph style set functionality from the Illustrator SDK. More...

#include <hdicoreTextParaStyleSet.h>

Classes
class	Iterator
	Allows for iteration through the children of a paragraph style 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
	TextParaStyleSet ()
	Creates a new TextParaStyleSet object.
	TextParaStyleSet (const TextParaStyleSet &pss_)
	TextParaStyleSet copy constructor.
virtual	~TextParaStyleSet ()
	Destructs a TextParaStyleSet object.
virtual TextParaStyleSet &	operator= (const TextParaStyleSet &rhs_)
	Overloaded assignment operator for TextParaStyleSet objects.
virtual bool	operator== (const TextParaStyleSet &rhs_) const
	Tests whether a given TextParaStyleSet object is the same as another.
virtual bool	operator!= (const TextParaStyleSet &rhs_) const
	Tests whether a given TextParaStyleSet object is not the same as another.
virtual std::unique_ptr< ATE::IParaStyles >	ateParaStyleSet () const
	Gets the ATE paragraph style set ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextParaStyleSet object is empty.
virtual int32_t	size () const
	Gets the count of the contained paragraph styles.
virtual Iterator	begin () const
	Gets an iterator for the set.
virtual void	showAllStyles () const
	Shows all paragraph styles.
virtual void	showOnlyUnreferencedStyles () const
	Shows only styles to which there are not references in text.
virtual void	showOnlyStylesReferencedIn (const TextRange &range_)
	Shows only styles that are used in the given text range.
virtual void	moveStyleTo (const TextParaStyle &style_, const int32_t pos_)
	Reorders styles in this set by moving a style to a given position.

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

Detailed Description

Encapsulates paragraph style set functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextParaStyleSet() [1/2]

hdi::core::TextParaStyleSet::TextParaStyleSet

(

)

Creates a new TextParaStyleSet object.

Author

GW

Date

08/2014

Note

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

TextParaStyleSet() [2/2]

hdi::core::TextParaStyleSet::TextParaStyleSet

(

const TextParaStyleSet &

pss_

)

TextParaStyleSet copy constructor.

Author

GW

Date

08/2014

Parameters

pss_	TextParaStyleSet object to copy values from

~TextParaStyleSet()

virtual hdi::core::TextParaStyleSet::~TextParaStyleSet ( )

virtual

Destructs a TextParaStyleSet object.

Author

GW

Date

08/2014

Member Function Documentation

ateParaStyleSet()

virtual std::unique_ptr< ATE::IParaStyles > hdi::core::TextParaStyleSet::ateParaStyleSet ( ) const

virtual

Gets the ATE paragraph style set ref around which the target object is wrapped.

Author

GW

Date

08/2014

Returns

ATE::IParaStylesRef 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::TextParaStyleSet::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::TextParaStyleSet::Iterator iter = someSet.begin(); !iter.atEnd(); ++iter)
{
    // do stuff to iter.style()
}

isEmpty()

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

virtual

Gets whether the target TextParaStyleSet object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextParaStyleSet object is empty, false otherwise

Note

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

moveStyleTo()

virtual void hdi::core::TextParaStyleSet::moveStyleTo ( const TextParaStyle & style_, const int32_t pos_ )

virtual

Reorders styles in this set by moving a style to a given position.

Author

GW

Date

08/2014

Parameters

style_	Style to move
pos_	New index for style_

operator!=()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

true for the target and rhs_ being different text paragraph style sets, false otherwise

operator=()

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

virtual

Overloaded assignment operator for TextParaStyleSet objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextParaStyleSet object to copy values from

Returns

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

operator==()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

true for the target and rhs_ being the same text paragraph style set, false otherwise

showAllStyles()

virtual void hdi::core::TextParaStyleSet::showAllStyles ( ) const

virtual

Shows all paragraph styles.

Author

GW

Date

08/2014

showOnlyStylesReferencedIn()

virtual void hdi::core::TextParaStyleSet::showOnlyStylesReferencedIn ( const TextRange & range_ )

virtual

Shows only styles that are used in the given text range.

Author

GW

Date

08/2014

Parameters

range_

The text range in question

showOnlyUnreferencedStyles()

virtual void hdi::core::TextParaStyleSet::showOnlyUnreferencedStyles ( ) const

virtual

Shows only styles to which there are not references in text.

Author

GW

Date

08/2014

size()

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

virtual

Gets the count of the contained paragraph styles.

Author

GW

Date

08/2014

Returns

The count of the contained paragraph style, or -1 if isEmpty() returns true