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

Public Member Functions

 TextCharStyle ()
 Creates a new TextCharStyle object. More...
 
 TextCharStyle (const TextCharStyle &cs_)
 TextCharStyle copy constructor. More...
 
virtual ~TextCharStyle ()
 Destructs a TextCharStyle object. More...
 
virtual TextCharStyleoperator= (const TextCharStyle &rhs_)
 Overloaded assignment operator for TextCharStyle objects. More...
 
virtual bool operator== (const TextCharStyle &rhs_) const
 Tests whether a given TextCharStyle object is the same as another. More...
 
virtual bool operator!= (const TextCharStyle &rhs_) const
 Tests whether a given TextCharStyle object is not the same as another. More...
 
virtual std::auto_ptr< ATE::ICharStyle > ateCharStyle () const
 Gets the ATE char style ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextCharStyle object is empty. More...
 
virtual std::string name () const
 Gets the name of the char style. More...
 
virtual bool setName (const std::string &name_)
 Sets the name of the char style. More...
 
virtual std::auto_ptr< TextCharStyleparent () const
 Gets the parent style of the target char style object. More...
 
virtual bool setParent (const TextCharStyle &parent_)
 Sets the parent style of the target char style object. More...
 
virtual bool hasParent () const
 Gets whether the target object has a parent. More...
 
virtual std::auto_ptr< TextCharFeaturesfeatures () const
 Gets the features defined for the target style. More...
 
virtual void setFeatures (const TextCharFeatures &feat_)
 Sets the features defined for the target style. More...
 
virtual void replaceOrAddFeatures (const TextCharFeatures &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::TextCharStyle * __accessImpl (const TextCharStyle &)
 
TextCharStyle __accessCtor (const plugin::TextCharStyle &)
 

Constructor & Destructor Documentation

hdi::core::TextCharStyle::TextCharStyle ( )

Creates a new TextCharStyle object.

Author
GW
Date
08/2014
Note
New TextCharStyle objects do not relate to any text char style on the Illustrator artboard; they are designed to be "receivers" of some other TextCharStyle object via the overloaded assignment operator or assigned to some other existent text art.
hdi::core::TextCharStyle::TextCharStyle ( const TextCharStyle cs_)

TextCharStyle copy constructor.

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

Destructs a TextCharStyle object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_ptr<ATE::ICharStyle> hdi::core::TextCharStyle::ateCharStyle ( ) const
virtual

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

Author
GW
Date
08/2014
Returns
ATE::ICharStyleRef 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<TextCharFeatures> hdi::core::TextCharStyle::features ( ) const
virtual

Gets the features defined for the target style.

Author
GW
Date
08/2014
Returns
The TextCharFeatures object for the style, or NULL for error
virtual bool hdi::core::TextCharStyle::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::TextCharStyle::isEmpty ( ) const
virtual

Gets whether the target TextCharStyle object is empty.

Author
GW
Date
08/2014
Returns
true if the target TextCharStyle object is empty, false otherwise
virtual std::string hdi::core::TextCharStyle::name ( ) const
virtual

Gets the name of the char style.

Author
GW
Date
08/2014
Returns
The char style name, as UTF-8
virtual bool hdi::core::TextCharStyle::operator!= ( const TextCharStyle rhs_) const
virtual

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

Author
GW
Date
08/2014
Parameters
rhs_TextCharStyle to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different text char styles, false otherwise
virtual TextCharStyle& hdi::core::TextCharStyle::operator= ( const TextCharStyle rhs_)
virtual

Overloaded assignment operator for TextCharStyle objects.

Author
GW
Date
08/2014
virtual bool hdi::core::TextCharStyle::operator== ( const TextCharStyle rhs_) const
virtual

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

Author
GW
Date
08/2014
Parameters
rhs_TextCharStyle to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text char style, false otherwise
virtual std::auto_ptr<TextCharStyle> hdi::core::TextCharStyle::parent ( ) const
virtual

Gets the parent style of the target char style object.

Author
GW
Date
08/2014
Returns
The TextCharStyle object for the parent, or NULL for none
virtual void hdi::core::TextCharStyle::replaceOrAddFeatures ( const TextCharFeatures 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 TextCharFeatures object for the style
virtual void hdi::core::TextCharStyle::setFeatures ( const TextCharFeatures feat_)
virtual

Sets the features defined for the target style.

Author
GW
Date
08/2014
Parameters
feat_New TextCharFeatures object for the style
virtual bool hdi::core::TextCharStyle::setName ( const std::string &  name_)
virtual

Sets the name of the char style.

Author
GW
Date
08/2014
Parameters
name_New char style name, as UTF-8
Returns
true if the name could be set, false otherwise
virtual bool hdi::core::TextCharStyle::setParent ( const TextCharStyle parent_)
virtual

Sets the parent style of the target char style object.

Author
GW
Date
08/2014
Parameters
parent_New TextCharStyle parent
Returns
true if the parent could be set, false otherwise