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< ArtColor >	ArtColorVector
typedef std::vector< bool >	BoolVector
typedef std::vector< double >	DoubleVector
typedef std::vector< std::shared_ptr< Font > >	FontVector
typedef std::vector< int32_t >	IntVector
typedef std::vector< StrokeStyle::CapStyle >	CapStyleVector
typedef std::vector< FigureStyle >	FigureStyleVector
typedef std::vector< FontCapsType >	FontCapsTypeVector
typedef std::vector< FontBaseline >	FontBaselineVector
typedef std::vector< FontOpenTypePosition >	FontOpenTypePositionVector
typedef std::vector< StrokeStyle::JoinStyle >	JoinStyleVector
typedef std::vector< StrikethroughPosition >	StrikethroughPositionVector
typedef std::vector< UnderlinePosition >	UnderlinePositionVector

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

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

Detailed Description

Allows for easy inspection of Illustrator text characters.

Constructor & Destructor Documentation

◆ TextCharInspector() [1/2]

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.

◆ TextCharInspector() [2/2]

hdi::core::TextCharInspector::TextCharInspector ( const TextCharInspector & ci_ )

TextCharInspector copy constructor.

Author: GW

Date: 12/2013

Parameters

ci_	TextCharInspector object to copy values from

◆ ~TextCharInspector()

virtual hdi::core::TextCharInspector::~TextCharInspector ( )

virtual

Destructs a TextCharInspector object.

Author: GW

Date: 12/2013

Member Function Documentation

◆ alternateLigatures()

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

◆ ateCharInspector()

virtual std::unique_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.

◆ autoLeading()

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

◆ baselineShift()

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

◆ characterRotation()

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

◆ connectionForms()

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

◆ contextualLigatures()

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

◆ discretionaryLigatures()

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

◆ figureStyle()

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

◆ fill()

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

◆ fillBackground()

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

◆ fillBackgroundColor()

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

◆ fillColor()

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

◆ fillFirst()

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

◆ fillOverPrint()

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

◆ fillVisible()

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

◆ font()

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

◆ fontBaseline()

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

◆ fontCaps()

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

◆ fontOpenTypePosition()

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

◆ fontSize()

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

◆ fractions()

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

◆ horizontalScale()

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

◆ isEmpty()

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

◆ leading()

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

◆ ligature()

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

◆ lineCap()

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

◆ lineDashArray()

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

◆ lineDashOffset()

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

◆ lineJoin()

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

◆ lineWidth()

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

◆ miterLimit()

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

◆ noBreak()

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

◆ oldStyle()

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

◆ operator!=()

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

◆ operator=()

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

virtual

Overloaded assignment operator for TextCharInspector objects.

Author: GW

Date: 12/2013

Parameters

rhs_	Existing TextCharInspector object to copy values from

Returns: The target TextCharInspector object, but with its values updated to match that of rhs_

◆ operator==()

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

◆ ordinals()

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

◆ ornaments()

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

◆ strikethroughPosition()

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

◆ stroke()

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

◆ strokeColor()

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

◆ strokeOverPrint()

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

◆ strokeVisible()

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

◆ stylisticAlternates()

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

◆ stylisticSets()

IntVector hdi::core::TextCharInspector::stylisticSets ( ) const

Retrieves the style sets values from the character set.

Author: GW

Date: 07/2017

Returns: A vector of style sets values for each character being inspected

◆ swash()

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

◆ syntheticBold()

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

◆ syntheticItalic()

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

◆ titling()

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

◆ tracking()

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

◆ underlineOffset()

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

◆ underlinePosition()

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

◆ verticalScale()

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

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TextCharInspector() [1/2]

◆ TextCharInspector() [2/2]

◆ ~TextCharInspector()

Member Function Documentation

◆ alternateLigatures()

◆ ateCharInspector()

◆ autoLeading()

◆ baselineShift()

◆ characterRotation()

◆ connectionForms()

◆ contextualLigatures()

◆ discretionaryLigatures()

◆ figureStyle()

◆ fill()

◆ fillBackground()

◆ fillBackgroundColor()

◆ fillColor()

◆ fillFirst()

◆ fillOverPrint()

◆ fillVisible()

◆ font()

◆ fontBaseline()

◆ fontCaps()

◆ fontOpenTypePosition()

◆ fontSize()

◆ fractions()

◆ horizontalScale()

◆ isEmpty()

◆ leading()

◆ ligature()

◆ lineCap()

◆ lineDashArray()

◆ lineDashOffset()

◆ lineJoin()

◆ lineWidth()

◆ miterLimit()

◆ noBreak()

◆ oldStyle()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ ordinals()

◆ ornaments()

◆ strikethroughPosition()

◆ stroke()

◆ strokeColor()

◆ strokeOverPrint()

◆ strokeVisible()

◆ stylisticAlternates()

◆ stylisticSets()

◆ swash()

◆ syntheticBold()

◆ syntheticItalic()

◆ titling()

◆ tracking()

◆ underlineOffset()

◆ underlinePosition()

◆ verticalScale()