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

Classes

class  Iterator
 Allows for iteration through the children of a character style set, a la std::vector iteration. More...
 

Public Types

typedef std::auto_ptr< IteratorIteratorAP
 

Public Member Functions

 TextCharStyleSet ()
 Creates a new TextCharStyleSet object. More...
 
 TextCharStyleSet (const TextCharStyleSet &css_)
 TextCharStyleSet copy constructor. More...
 
virtual ~TextCharStyleSet ()
 Destructs a TextCharStyleSet object. More...
 
virtual TextCharStyleSetoperator= (const TextCharStyleSet &rhs_)
 Overloaded assignment operator for TextCharStyleSet objects. More...
 
virtual bool operator== (const TextCharStyleSet &rhs_) const
 Tests whether a given TextCharStyleSet object is the same as another. More...
 
virtual bool operator!= (const TextCharStyleSet &rhs_) const
 Tests whether a given TextCharStyleSet object is not the same as another. More...
 
virtual std::auto_ptr< ATE::ICharStyles > ateCharStyleSet () const
 Gets the ATE char style set ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextCharStyleSet object is empty. More...
 
virtual int32_t size () const
 Gets the count of the contained char styles. More...
 
virtual Iterator begin () const
 Gets an iterator for the set. More...
 
virtual void showAllStyles () const
 Shows all char styles. More...
 
virtual void showOnlyUnreferencedStyles () const
 Shows only styles to which there are not references in text. More...
 
virtual void showOnlyStylesReferencedIn (const TextRange &range_)
 Shows only styles that are used in the given text range. More...
 
virtual void moveStyleTo (const TextCharStyle &style_, const int32_t pos_)
 Reorders styles in this set by moving a style to a given position. More...
 

Friends

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

Constructor & Destructor Documentation

hdi::core::TextCharStyleSet::TextCharStyleSet ( )

Creates a new TextCharStyleSet object.

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

TextCharStyleSet copy constructor.

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

Destructs a TextCharStyleSet object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_ptr<ATE::ICharStyles> hdi::core::TextCharStyleSet::ateCharStyleSet ( ) const
virtual

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

Author
GW
Date
08/2014
Returns
ATE::ICharStylesRef 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 Iterator hdi::core::TextCharStyleSet::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::TextCharStyleSet::Iterator iter = someSet.begin(); !iter.atEnd(); ++iter)
{
// do stuff to iter.style()
}
virtual bool hdi::core::TextCharStyleSet::isEmpty ( ) const
virtual

Gets whether the target TextCharStyleSet object is empty.

Author
GW
Date
08/2014
Returns
true if the target TextCharStyleSet object is empty, false otherwise
Note
A TextCharStyleSet object being empty is not the same as it having a size of 0.
virtual void hdi::core::TextCharStyleSet::moveStyleTo ( const TextCharStyle 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_
virtual bool hdi::core::TextCharStyleSet::operator!= ( const TextCharStyleSet rhs_) const
virtual

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

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

Overloaded assignment operator for TextCharStyleSet objects.

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

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

Author
GW
Date
08/2014
Parameters
rhs_TextCharStyleSet to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text char style set, false otherwise
virtual void hdi::core::TextCharStyleSet::showAllStyles ( ) const
virtual

Shows all char styles.

Author
GW
Date
08/2014
virtual void hdi::core::TextCharStyleSet::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
virtual void hdi::core::TextCharStyleSet::showOnlyUnreferencedStyles ( ) const
virtual

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

Author
GW
Date
08/2014
virtual int32_t hdi::core::TextCharStyleSet::size ( ) const
virtual

Gets the count of the contained char styles.

Author
GW
Date
08/2014
Returns
The count of the contained char style, or -1 if isEmpty() returns true