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

Allows for easy inspection of Illustrator text characters. More...

#include <hdicoreTextCharInspector.h>

Public Types

enum  CollapseDirection { UnknownCollapseDir = 0, CollapseEndDir = 10, CollapseStartDir = 20 }
 
typedef std::vector< ArtColorArtColorVector
 
typedef std::vector< bool > BoolVector
 
typedef std::vector< double > DoubleVector
 
typedef std::vector< Font * > FontVector
 
typedef std::vector< int32_t > IntVector
 
typedef std::vector< StrokeStyle::CapStyleCapStyleVector
 
typedef std::vector< FigureStyle > FigureStyleVector
 
typedef std::vector< FontCapsType > FontCapsTypeVector
 
typedef std::vector< FontBaseline > FontBaselineVector
 
typedef std::vector< FontOpenTypePosition > FontOpenTypePositionVector
 
typedef std::vector< StrokeStyle::JoinStyleJoinStyleVector
 
typedef std::vector< StrikethroughPosition > StrikethroughPositionVector
 
typedef std::vector< UnderlinePosition > UnderlinePositionVector
 

Public Member Functions

 TextCharInspector ()
 Creates a new TextCharInspector object. More...
 
 TextCharInspector (const TextCharInspector &ci_)
 TextCharInspector copy constructor. More...
 
virtual ~TextCharInspector ()
 Destructs a TextCharInspector object. More...
 
virtual TextCharInspectoroperator= (const TextCharInspector &rhs_)
 Overloaded assignment operator for TextCharInspector objects. More...
 
virtual bool operator== (const TextCharInspector &rhs_) const
 Tests whether a given TextCharInspector object is the same as another. More...
 
virtual bool operator!= (const TextCharInspector &rhs_) const
 Tests whether a given TextCharInspector object is not the same as another. More...
 
virtual std::auto_ptr< ATE::ICharInspector > ateCharInspector () const
 Gets the ATE char inspector ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextCharInspector object is empty. More...
 
virtual FontVector font () const
 Retrieves the fonts from the character set. More...
 
virtual DoubleVector fontSize () const
 Retrieves the font size values from the character set. More...
 
virtual DoubleVector horizontalScale () const
 Retrieves the horizontal scale values from the character set. More...
 
virtual DoubleVector verticalScale () const
 Retrieves the vertical scale values from the character set. More...
 
virtual BoolVector syntheticBold () const
 Retrieves the synthetic bold values from the character set. More...
 
virtual BoolVector syntheticItalic () const
 Retrieves the synthetic italic values from the character set. More...
 
virtual BoolVector autoLeading () const
 Retrieves the auto-leading values from the character set. More...
 
virtual DoubleVector leading () const
 Retrieves the leading values from the character set. More...
 
virtual IntVector tracking () const
 Retrieves the tracking values from the character set. More...
 
virtual DoubleVector baselineShift () const
 Retrieves the baseline shift values from the character set. More...
 
virtual DoubleVector characterRotation () const
 Retrieves the char rotation values from the character set. More...
 
virtual FontCapsTypeVector fontCaps () const
 Retrieves the font cap values from the character set. More...
 
virtual FontBaselineVector fontBaseline () const
 Retrieves the font baseline values from the character set. More...
 
virtual FontOpenTypePositionVector fontOpenTypePosition () const
 Retrieves the font position values from the character set. More...
 
virtual StrikethroughPositionVector strikethroughPosition () const
 Retrieves the strikethrough position values from the character set. More...
 
virtual UnderlinePositionVector underlinePosition () const
 Retrieves the underline position values from the character set. More...
 
virtual DoubleVector underlineOffset () const
 Retrieves the underline offset values from the character set. More...
 
virtual BoolVector ligature () const
 Retrieves the ligature values from the character set. More...
 
virtual BoolVector discretionaryLigatures () const
 Retrieves the discretionary ligature values from the character set. More...
 
virtual BoolVector contextualLigatures () const
 Retrieves the contextual ligature values from the character set. More...
 
virtual BoolVector alternateLigatures () const
 Retrieves the alternate ligature values from the character set. More...
 
virtual BoolVector oldStyle () const
 Retrieves the old-style values from the character set. More...
 
virtual BoolVector fractions () const
 Retrieves the fraction values from the character set. More...
 
virtual BoolVector ordinals () const
 Retrieves the ordinal values from the character set. More...
 
virtual BoolVector swash () const
 Retrieves the swash values from the character set. More...
 
virtual BoolVector titling () const
 Retrieves the titling values from the character set. More...
 
virtual BoolVector connectionForms () const
 Retrieves the connection form values from the character set. More...
 
virtual BoolVector stylisticAlternates () const
 Retrieves the style alternative values from the character set. More...
 
virtual BoolVector ornaments () const
 Retrieves the ornament values from the character set. More...
 
virtual FigureStyleVector figureStyle () const
 Retrieves the figure style values from the character set. More...
 
virtual BoolVector noBreak () const
 Retrieves the no-break values from the character set. More...
 
virtual BoolVector fill () const
 Retrieves the fill values from the character set. More...
 
virtual BoolVector fillVisible () const
 Retrieves the fill visibility values from the character set. More...
 
virtual ArtColorVector fillColor () const
 Retrieves the fill color values from the character set. More...
 
virtual BoolVector fillFirst () const
 Retrieves the fill-first values from the character set. More...
 
virtual BoolVector fillOverPrint () const
 Retrieves the fill overprint values from the character set. More...
 
virtual BoolVector fillBackground () const
 Retrieves the background fill values from the character set. More...
 
virtual ArtColorVector fillBackgroundColor () const
 Retrieves the background fill color values from the character set. More...
 
virtual BoolVector stroke () const
 Retrieves the stroke values from the character set. More...
 
virtual BoolVector strokeVisible () const
 Retrieves the stroke visibility values from the character set. More...
 
virtual ArtColorVector strokeColor () const
 Retrieves the stroke color values from the character set. More...
 
virtual BoolVector strokeOverPrint () const
 Retrieves the stroke overprint values from the character set. More...
 
virtual CapStyleVector lineCap () const
 Retrieves the line cap values from the character set. More...
 
virtual JoinStyleVector lineJoin () const
 Retrieves the line join values from the character set. More...
 
virtual DoubleVector lineWidth () const
 Retrieves the line width values from the character set. More...
 
virtual DoubleVector miterLimit () const
 Retrieves the miter limit values from the character set. More...
 
virtual DoubleVector lineDashOffset () const
 Retrieves the line dash offset values from the character set. More...
 
virtual std::vector< DoubleVector > lineDashArray () const
 Retrieves the line dash values from the character set. More...
 

Friends

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

Detailed Description

Allows for easy inspection of Illustrator text characters.

Constructor & Destructor Documentation

hdi::core::TextCharInspector::TextCharInspector ( )

Creates a new TextCharInspector object.

Author
GW
Date
12/2013
Note
New TextCharInspector objects do not relate to any text characters on the Illustrator artboard; they are designed to be "receivers" of some other TextCharInspector object via the overloaded assignment operator or assigned to some other existent text art.
hdi::core::TextCharInspector::TextCharInspector ( const TextCharInspector ci_)

TextCharInspector copy constructor.

Author
GW
Date
12/2013
Parameters
ci_TextCharInspector object to copy values from
virtual hdi::core::TextCharInspector::~TextCharInspector ( )
virtual

Destructs a TextCharInspector object.

Author
GW
Date
12/2013

Member Function Documentation

virtual BoolVector hdi::core::TextCharInspector::alternateLigatures ( ) const
virtual

Retrieves the alternate ligature values from the character set.

Author
GW
Date
12/2013
Returns
A vector of alternate ligature settings for each character being inspected
virtual std::auto_ptr<ATE::ICharInspector> hdi::core::TextCharInspector::ateCharInspector ( ) const
virtual

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

Author
GW
Date
12/2013
Returns
ATE::ICharInspector 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 BoolVector hdi::core::TextCharInspector::autoLeading ( ) const
virtual

Retrieves the auto-leading values from the character set.

Author
GW
Date
12/2013
Returns
A vector of auto-leading settings for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::baselineShift ( ) const
virtual

Retrieves the baseline shift values from the character set.

Author
GW
Date
12/2013
Returns
A vector of baseline shifts for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::characterRotation ( ) const
virtual

Retrieves the char rotation values from the character set.

Author
GW
Date
12/2013
Returns
A vector of char rotations for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::connectionForms ( ) const
virtual

Retrieves the connection form values from the character set.

Author
GW
Date
12/2013
Returns
A vector of connection form settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::contextualLigatures ( ) const
virtual

Retrieves the contextual ligature values from the character set.

Author
GW
Date
12/2013
Returns
A vector of contextual ligature settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::discretionaryLigatures ( ) const
virtual

Retrieves the discretionary ligature values from the character set.

Author
GW
Date
12/2013
Returns
A vector of discretionary ligature settings for each character being inspected
virtual FigureStyleVector hdi::core::TextCharInspector::figureStyle ( ) const
virtual

Retrieves the figure style values from the character set.

Author
GW
Date
12/2013
Returns
A vector of figure styles for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fill ( ) const
virtual

Retrieves the fill values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fill settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fillBackground ( ) const
virtual

Retrieves the background fill values from the character set.

Author
GW
Date
12/2013
Returns
A vector of background fills for each character being inspected
virtual ArtColorVector hdi::core::TextCharInspector::fillBackgroundColor ( ) const
virtual

Retrieves the background fill color values from the character set.

Author
GW
Date
12/2013
Returns
A vector of background fill colors for each character being inspected
virtual ArtColorVector hdi::core::TextCharInspector::fillColor ( ) const
virtual

Retrieves the fill color values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fill colors for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fillFirst ( ) const
virtual

Retrieves the fill-first values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fill-first settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fillOverPrint ( ) const
virtual

Retrieves the fill overprint values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fill overprint settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fillVisible ( ) const
virtual

Retrieves the fill visibility values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fill visibility settings for each character being inspected
virtual FontVector hdi::core::TextCharInspector::font ( ) const
virtual

Retrieves the fonts from the character set.

Author
GW
Date
12/2013
Returns
A vector of fonts for each character being inspected
Warning
The caller assumes responsibility for the memory of the contained Font objects.
virtual FontBaselineVector hdi::core::TextCharInspector::fontBaseline ( ) const
virtual

Retrieves the font baseline values from the character set.

Author
GW
Date
12/2013
Returns
A vector of font baselines for each character being inspected
virtual FontCapsTypeVector hdi::core::TextCharInspector::fontCaps ( ) const
virtual

Retrieves the font cap values from the character set.

Author
GW
Date
12/2013
Returns
A vector of font caps for each character being inspected
virtual FontOpenTypePositionVector hdi::core::TextCharInspector::fontOpenTypePosition ( ) const
virtual

Retrieves the font position values from the character set.

Author
GW
Date
12/2013
Returns
A vector of font positions for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::fontSize ( ) const
virtual

Retrieves the font size values from the character set.

Author
GW
Date
12/2013
Returns
A vector of font sizes for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::fractions ( ) const
virtual

Retrieves the fraction values from the character set.

Author
GW
Date
12/2013
Returns
A vector of fraction settings for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::horizontalScale ( ) const
virtual

Retrieves the horizontal scale values from the character set.

Author
GW
Date
12/2013
Returns
A vector of horizontal scales for each character being inspected
virtual bool hdi::core::TextCharInspector::isEmpty ( ) const
virtual

Gets whether the target TextCharInspector object is empty.

Author
GW
Date
12/2013
Returns
true if the target TextCharInspector object is empty, false otherwise
virtual DoubleVector hdi::core::TextCharInspector::leading ( ) const
virtual

Retrieves the leading values from the character set.

Author
GW
Date
12/2013
Returns
A vector of leading values for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::ligature ( ) const
virtual

Retrieves the ligature values from the character set.

Author
GW
Date
12/2013
Returns
A vector of ligature settings for each character being inspected
virtual CapStyleVector hdi::core::TextCharInspector::lineCap ( ) const
virtual

Retrieves the line cap values from the character set.

Author
GW
Date
12/2013
Returns
A vector of line caps for each character being inspected
virtual std::vector<DoubleVector> hdi::core::TextCharInspector::lineDashArray ( ) const
virtual

Retrieves the line dash values from the character set.

Author
GW
Date
12/2013
Returns
A vector of vectors of line dashes for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::lineDashOffset ( ) const
virtual

Retrieves the line dash offset values from the character set.

Author
GW
Date
12/2013
Returns
A vector of line dash offsets for each character being inspected
virtual JoinStyleVector hdi::core::TextCharInspector::lineJoin ( ) const
virtual

Retrieves the line join values from the character set.

Author
GW
Date
12/2013
Returns
A vector of line joins for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::lineWidth ( ) const
virtual

Retrieves the line width values from the character set.

Author
GW
Date
12/2013
Returns
A vector of line widths for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::miterLimit ( ) const
virtual

Retrieves the miter limit values from the character set.

Author
GW
Date
12/2013
Returns
A vector of miter limits for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::noBreak ( ) const
virtual

Retrieves the no-break values from the character set.

Author
GW
Date
12/2013
Returns
A vector of no-break settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::oldStyle ( ) const
virtual

Retrieves the old-style values from the character set.

Author
GW
Date
12/2013
Returns
A vector of old-style settings for each character being inspected
virtual bool hdi::core::TextCharInspector::operator!= ( const TextCharInspector rhs_) const
virtual

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

Author
GW
Date
12/2013
Parameters
rhs_TextCharInspector to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different text char inspectors, false otherwise
virtual TextCharInspector& hdi::core::TextCharInspector::operator= ( const TextCharInspector rhs_)
virtual

Overloaded assignment operator for TextCharInspector objects.

Author
GW
Date
12/2013
virtual bool hdi::core::TextCharInspector::operator== ( const TextCharInspector rhs_) const
virtual

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

Author
GW
Date
12/2013
Parameters
rhs_TextCharInspector to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text char inspector, false otherwise
virtual BoolVector hdi::core::TextCharInspector::ordinals ( ) const
virtual

Retrieves the ordinal values from the character set.

Author
GW
Date
12/2013
Returns
A vector of ordinal settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::ornaments ( ) const
virtual

Retrieves the ornament values from the character set.

Author
GW
Date
12/2013
Returns
A vector of ornaments for each character being inspected
virtual StrikethroughPositionVector hdi::core::TextCharInspector::strikethroughPosition ( ) const
virtual

Retrieves the strikethrough position values from the character set.

Author
GW
Date
12/2013
Returns
A vector of strikethrough positions for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::stroke ( ) const
virtual

Retrieves the stroke values from the character set.

Author
GW
Date
12/2013
Returns
A vector of stroke settings for each character being inspected
virtual ArtColorVector hdi::core::TextCharInspector::strokeColor ( ) const
virtual

Retrieves the stroke color values from the character set.

Author
GW
Date
12/2013
Returns
A vector of stroke colors for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::strokeOverPrint ( ) const
virtual

Retrieves the stroke overprint values from the character set.

Author
GW
Date
12/2013
Returns
A vector of stroke overprint settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::strokeVisible ( ) const
virtual

Retrieves the stroke visibility values from the character set.

Author
GW
Date
12/2013
Returns
A vector of stroke visibility settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::stylisticAlternates ( ) const
virtual

Retrieves the style alternative values from the character set.

Author
GW
Date
12/2013
Returns
A vector of style alternative settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::swash ( ) const
virtual

Retrieves the swash values from the character set.

Author
GW
Date
12/2013
Returns
A vector of swash settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::syntheticBold ( ) const
virtual

Retrieves the synthetic bold values from the character set.

Author
GW
Date
12/2013
Returns
A vector of synthetic bold settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::syntheticItalic ( ) const
virtual

Retrieves the synthetic italic values from the character set.

Author
GW
Date
12/2013
Returns
A vector of synthetic italic settings for each character being inspected
virtual BoolVector hdi::core::TextCharInspector::titling ( ) const
virtual

Retrieves the titling values from the character set.

Author
GW
Date
12/2013
Returns
A vector of titling settings for each character being inspected
virtual IntVector hdi::core::TextCharInspector::tracking ( ) const
virtual

Retrieves the tracking values from the character set.

Author
GW
Date
12/2013
Returns
A vector of tracking values for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::underlineOffset ( ) const
virtual

Retrieves the underline offset values from the character set.

Author
GW
Date
12/2013
Returns
A vector of underline offsets for each character being inspected
virtual UnderlinePositionVector hdi::core::TextCharInspector::underlinePosition ( ) const
virtual

Retrieves the underline position values from the character set.

Author
GW
Date
12/2013
Returns
A vector of underline positions for each character being inspected
virtual DoubleVector hdi::core::TextCharInspector::verticalScale ( ) const
virtual

Retrieves the vertical scale values from the character set.

Author
GW
Date
12/2013
Returns
A vector of vertical scales for each character being inspected