Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Friends | List of all members
hdi::core::TextParaStyle Class Reference

Public Member Functions

 TextParaStyle ()
 Creates a new TextParaStyle object. More...
 
 TextParaStyle (const TextParaStyle &ps_)
 TextParaStyle copy constructor. More...
 
virtual ~TextParaStyle ()
 Destructs a TextParaStyle object. More...
 
virtual TextParaStyleoperator= (const TextParaStyle &rhs_)
 Overloaded assignment operator for TextParaStyle objects. More...
 
virtual bool operator== (const TextParaStyle &rhs_) const
 Tests whether a given TextParaStyle object is the same as another. More...
 
virtual bool operator!= (const TextParaStyle &rhs_) const
 Tests whether a given TextParaStyle object is not the same as another. More...
 
virtual std::auto_ptr< ATE::IParaStyle > ateParaStyle () const
 Gets the ATE paragraph style ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextParaStyle object is empty. More...
 
virtual std::string name () const
 Gets the name of the paragraph style. More...
 
virtual bool setName (const std::string &name_)
 Sets the name of the paragraph style. More...
 
virtual std::auto_ptr< TextParaStyleparent () const
 Gets the parent style of the target paragraph style object. More...
 
virtual bool setParent (const TextParaStyle &parent_)
 Sets the parent style of the target paragraph style object. More...
 
virtual bool hasParent () const
 Gets whether the target object has a parent. More...
 
virtual std::auto_ptr< TextParaFeaturesfeatures () const
 Gets the features defined for the target style. More...
 
virtual void setFeatures (const TextParaFeatures &feat_)
 Sets the features defined for the target style. More...
 
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). More...
 

Friends

plugin::TextParaStyle * __accessImpl (const TextParaStyle &)
 
TextParaStyle __accessCtor (const plugin::TextParaStyle &)
 

Constructor & Destructor Documentation

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.
hdi::core::TextParaStyle::TextParaStyle ( const TextParaStyle ps_)

TextParaStyle copy constructor.

Author
GW
Date
08/2014
Parameters
ps_TextParaStyle object to copy values from
virtual hdi::core::TextParaStyle::~TextParaStyle ( )
virtual

Destructs a TextParaStyle object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_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.
virtual std::auto_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
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
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
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
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
virtual TextParaStyle& hdi::core::TextParaStyle::operator= ( const TextParaStyle rhs_)
virtual

Overloaded assignment operator for TextParaStyle objects.

Author
GW
Date
08/2014
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
virtual std::auto_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
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
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
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
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