hdi::core::TextParaStyle Class Reference

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

#include <hdicoreTextParaStyle.h>

Public Member Functions
	TextParaStyle ()
	Creates a new TextParaStyle object.
	TextParaStyle (const TextParaStyle &ps_)
	TextParaStyle copy constructor.
virtual	~TextParaStyle ()
	Destructs a TextParaStyle object.
virtual TextParaStyle &	operator= (const TextParaStyle &rhs_)
	Overloaded assignment operator for TextParaStyle objects.
virtual bool	operator== (const TextParaStyle &rhs_) const
	Tests whether a given TextParaStyle object is the same as another.
virtual bool	operator!= (const TextParaStyle &rhs_) const
	Tests whether a given TextParaStyle object is not the same as another.
virtual std::unique_ptr< ATE::IParaStyle >	ateParaStyle () const
	Gets the ATE paragraph style ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextParaStyle object is empty.
virtual std::string	name () const
	Gets the name of the paragraph style.
virtual bool	setName (const std::string &name_)
	Sets the name of the paragraph style.
virtual std::unique_ptr< TextParaStyle >	parent () const
	Gets the parent style of the target paragraph style object.
virtual bool	setParent (const TextParaStyle &parent_)
	Sets the parent style of the target paragraph style object.
virtual bool	hasParent () const
	Gets whether the target object has a parent.
virtual std::unique_ptr< TextParaFeatures >	features () const
	Gets the features defined for the target style.
virtual void	setFeatures (const TextParaFeatures &feat_)
	Sets the features defined for the target style.
virtual void	replaceOrAddFeatures (const TextParaFeatures &feat_)
	Replaces existing features in the target style, or adds them anew if they were not already present (values that are unassigned in the replacement set remain unchanged in the target style).

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

Detailed Description

Encapsulates paragraph style functionality from the Illustrator SDK.

Constructor & Destructor Documentation

TextParaStyle() [1/2]

hdi::core::TextParaStyle::TextParaStyle

(

)

Creates a new TextParaStyle object.

Author

GW

Date

08/2014

Note

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

TextParaStyle() [2/2]

hdi::core::TextParaStyle::TextParaStyle

(

const TextParaStyle &

ps_

)

TextParaStyle copy constructor.

Author

GW

Date

08/2014

Parameters

ps_	TextParaStyle object to copy values from

~TextParaStyle()

virtual hdi::core::TextParaStyle::~TextParaStyle ( )

virtual

Destructs a TextParaStyle object.

Author

GW

Date

08/2014

Member Function Documentation

ateParaStyle()

virtual std::unique_ptr< ATE::IParaStyle > hdi::core::TextParaStyle::ateParaStyle ( ) const

virtual

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

Author

GW

Date

08/2014

Returns

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

features()

virtual std::unique_ptr< TextParaFeatures > hdi::core::TextParaStyle::features ( ) const

virtual

Gets the features defined for the target style.

Author

GW

Date

08/2014

Returns

The TextParaFeatures object for the style, or NULL for error

hasParent()

virtual bool hdi::core::TextParaStyle::hasParent ( ) const

virtual

Gets whether the target object has a parent.

Author

GW

Date

08/2014

Returns

true if a parent exists, false otherwise

isEmpty()

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

virtual

Gets whether the target TextParaStyle object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextParaStyle object is empty, false otherwise

name()

virtual std::string hdi::core::TextParaStyle::name ( ) const

virtual

Gets the name of the paragraph style.

Author

GW

Date

08/2014

Returns

The paragraph style name, as UTF-8

operator!=()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

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

operator=()

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

virtual

Overloaded assignment operator for TextParaStyle objects.

Author

GW

Date

08/2014

Parameters

rhs_	Existing TextParaStyle object to copy values from

Returns

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

operator==()

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

virtual

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

Author

GW

Date

08/2014

Parameters

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

Returns

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

parent()

virtual std::unique_ptr< TextParaStyle > hdi::core::TextParaStyle::parent ( ) const

virtual

Gets the parent style of the target paragraph style object.

Author

GW

Date

08/2014

Returns

The TextParaStyle object for the parent, or NULL for none

replaceOrAddFeatures()

virtual void hdi::core::TextParaStyle::replaceOrAddFeatures ( const TextParaFeatures & feat_ )

virtual

Replaces existing features in the target style, or adds them anew if they were not already present (values that are unassigned in the replacement set remain unchanged in the target style).

Author

GW

Date

08/2014

Parameters

feat_

New/replacement TextParaFeatures object for the style

setFeatures()

virtual void hdi::core::TextParaStyle::setFeatures ( const TextParaFeatures & feat_ )

virtual

Sets the features defined for the target style.

Author

GW

Date

08/2014

Parameters

feat_

New TextParaFeatures object for the style

setName()

virtual bool hdi::core::TextParaStyle::setName ( const std::string & name_ )

virtual

Sets the name of the paragraph style.

Author

GW

Date

08/2014

Parameters

name_

New paragraph style name, as UTF-8

Returns

true if the name could be set, false otherwise

setParent()

virtual bool hdi::core::TextParaStyle::setParent ( const TextParaStyle & parent_ )

virtual

Sets the parent style of the target paragraph style object.

Author

GW

Date

08/2014

Parameters

parent_

New TextParaStyle parent

Returns

true if the parent could be set, false otherwise