hdi::core::TextParaInspector Class Reference

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

#include <hdicoreTextParaInspector.h>

Public Types
typedef std::vector< bool >	BoolVector
typedef std::vector< double >	DoubleVector
typedef std::vector< int32_t >	IntVector
typedef std::vector< ComposerEngine >	ComposerEngineVector
typedef std::vector< LeadingType >	LeadingTypeVector
typedef std::vector< ParagraphJustification >	ParagraphJustificationVector

Public Member Functions
	TextParaInspector ()
	Creates a new TextParaInspector object.
	TextParaInspector (const TextParaInspector &pi_)
	TextParaInspector copy constructor.
virtual	~TextParaInspector ()
	Destructs a TextParaInspector object.
virtual TextParaInspector &	operator= (const TextParaInspector &rhs_)
	Overloaded assignment operator for TextParaInspector objects.
virtual bool	operator== (const TextParaInspector &rhs_) const
	Tests whether a given TextParaInspector object is the same as another.
virtual bool	operator!= (const TextParaInspector &rhs_) const
	Tests whether a given TextParaInspector object is not the same as another.
virtual std::unique_ptr< ATE::IParaInspector >	ateParaInspector () const
	Gets the ATE char inspector ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextParaInspector object is empty.
virtual ParagraphJustificationVector	justification () const
	Retrieves the justification values from the paragraph set.
virtual DoubleVector	firstLineIndent () const
	Retrieves the first-line indent values from the paragraph set.
virtual DoubleVector	startIndent () const
	Retrieves the start-indent values from the paragraph set.
virtual DoubleVector	endIndent () const
	Retrieves the end-indent values from the paragraph set.
virtual DoubleVector	spaceBefore () const
	Retrieves the space-before values from the paragraph set.
virtual DoubleVector	spaceAfter () const
	Retrieves the space-after values from the paragraph set.
virtual BoolVector	autoHyphenate () const
	Retrieves the auto-hyphenate values from the paragraph set.
virtual IntVector	hyphenatedWordSize () const
	Retrieves the hyphenated word size values from the paragraph set.
virtual IntVector	preHyphenSize () const
	Retrieves the pre-hyphen size values from the paragraph set.
virtual IntVector	postHyphenSize () const
	Retrieves the post-hyphen size values from the paragraph set.
virtual IntVector	consecutiveHyphenLimit () const
	Retrieves the consecutive hyphen limit values from the paragraph set.
virtual DoubleVector	hyphenationZone () const
	Retrieves the hyphenation zone values from the paragraph set.
virtual BoolVector	hyphenateCapitalized () const
	Retrieves the hyphenate capitalized settings from the paragraph set.
virtual DoubleVector	hyphenationPreference () const
	Retrieves the hyphenation pref values from the paragraph set.
virtual DoubleVector	desiredWordSpacing () const
	Retrieves the desired word spacing values from the paragraph set.
virtual DoubleVector	minWordSpacing () const
	Retrieves the min word spacing values from the paragraph set.
virtual DoubleVector	maxWordSpacing () const
	Retrieves the max word spacing values from the paragraph set.
virtual DoubleVector	desiredLetterSpacing () const
	Retrieves the desired letter spacing values from the paragraph set.
virtual DoubleVector	minLetterSpacing () const
	Retrieves the min letter spacing values from the paragraph set.
virtual DoubleVector	maxLetterSpacing () const
	Retrieves the max letter spacing values from the paragraph set.
virtual DoubleVector	desiredGlyphScaling () const
	Retrieves the desired glyph scaling values from the paragraph set.
virtual DoubleVector	minGlyphScaling () const
	Retrieves the min glyph scaling values from the paragraph set.
virtual DoubleVector	maxGlyphScaling () const
	Retrieves the max glyph scaling values from the paragraph set.
virtual ParagraphJustificationVector	singleWordJustification () const
	Retrieves the single-word justification values from the paragraph set.
virtual DoubleVector	autoLeadingPercentage () const
	Retrieves the auto-leading percentage values from the paragraph set.
virtual LeadingTypeVector	leadingType () const
	Retrieves the leading types from the paragraph set.
virtual DoubleVector	defaultTabWidth () const
	Retrieves the default tab width values from the paragraph set.
virtual BoolVector	everyLineComposer () const
	Retrieves the every-line composer values from the paragraph set.
virtual ComposerEngineVector	composerEngine () const
	Retrieves the composer engine values from the paragraph set.

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

Detailed Description

Allows for easy inspection of Illustrator text characters.

Constructor & Destructor Documentation

TextParaInspector() [1/2]

hdi::core::TextParaInspector::TextParaInspector

(

)

Creates a new TextParaInspector object.

Author

GW

Date

12/2013

Note

New TextParaInspector objects do not relate to any text characters on the Illustrator artboard; they are designed to be "receivers" of some other TextParaInspector object via the overloaded assignment operator or assigned to some other existent text art.

TextParaInspector() [2/2]

hdi::core::TextParaInspector::TextParaInspector

(

const TextParaInspector &

pi_

)

TextParaInspector copy constructor.

Author

GW

Date

12/2013

Parameters

pi_	TextParaInspector object to copy values from

~TextParaInspector()

virtual hdi::core::TextParaInspector::~TextParaInspector ( )

virtual

Destructs a TextParaInspector object.

Author

GW

Date

12/2013

Member Function Documentation

ateParaInspector()

virtual std::unique_ptr< ATE::IParaInspector > hdi::core::TextParaInspector::ateParaInspector ( ) const

virtual

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

Author

GW

Date

12/2013

Returns

ATE::IParaInspector 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.

autoHyphenate()

virtual BoolVector hdi::core::TextParaInspector::autoHyphenate ( ) const

virtual

Retrieves the auto-hyphenate values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of auto-hyphenate settings for each paragraph being inspected

autoLeadingPercentage()

virtual DoubleVector hdi::core::TextParaInspector::autoLeadingPercentage ( ) const

virtual

Retrieves the auto-leading percentage values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of auto-leading percentages for each paragraph being inspected

composerEngine()

virtual ComposerEngineVector hdi::core::TextParaInspector::composerEngine ( ) const

virtual

Retrieves the composer engine values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of composer engines for each paragraph being inspected

consecutiveHyphenLimit()

virtual IntVector hdi::core::TextParaInspector::consecutiveHyphenLimit ( ) const

virtual

Retrieves the consecutive hyphen limit values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of consecutive hyphen limits for each paragraph being inspected

defaultTabWidth()

virtual DoubleVector hdi::core::TextParaInspector::defaultTabWidth ( ) const

virtual

Retrieves the default tab width values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of default tab widths for each paragraph being inspected

desiredGlyphScaling()

virtual DoubleVector hdi::core::TextParaInspector::desiredGlyphScaling ( ) const

virtual

Retrieves the desired glyph scaling values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of desired glyph scalings for each paragraph being inspected

desiredLetterSpacing()

virtual DoubleVector hdi::core::TextParaInspector::desiredLetterSpacing ( ) const

virtual

Retrieves the desired letter spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of desired letter spacings for each paragraph being inspected

desiredWordSpacing()

virtual DoubleVector hdi::core::TextParaInspector::desiredWordSpacing ( ) const

virtual

Retrieves the desired word spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of desired word spacings for each paragraph being inspected

endIndent()

virtual DoubleVector hdi::core::TextParaInspector::endIndent ( ) const

virtual

Retrieves the end-indent values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of end-indent settings for each paragraph being inspected

everyLineComposer()

virtual BoolVector hdi::core::TextParaInspector::everyLineComposer ( ) const

virtual

Retrieves the every-line composer values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of every-line composer values for each paragraph being inspected

firstLineIndent()

virtual DoubleVector hdi::core::TextParaInspector::firstLineIndent ( ) const

virtual

Retrieves the first-line indent values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of first-line indent settings for each paragraph being inspected

hyphenateCapitalized()

virtual BoolVector hdi::core::TextParaInspector::hyphenateCapitalized ( ) const

virtual

Retrieves the hyphenate capitalized settings from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of hyphenate capitalized settings for each paragraph being inspected

hyphenatedWordSize()

virtual IntVector hdi::core::TextParaInspector::hyphenatedWordSize ( ) const

virtual

Retrieves the hyphenated word size values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of hyphenated word sizes for each paragraph being inspected

hyphenationPreference()

virtual DoubleVector hdi::core::TextParaInspector::hyphenationPreference ( ) const

virtual

Retrieves the hyphenation pref values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of hyphenation prefs for each paragraph being inspected

hyphenationZone()

virtual DoubleVector hdi::core::TextParaInspector::hyphenationZone ( ) const

virtual

Retrieves the hyphenation zone values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of hyphenation zones for each paragraph being inspected

isEmpty()

virtual bool hdi::core::TextParaInspector::isEmpty ( ) const

virtual

Gets whether the target TextParaInspector object is empty.

Author

GW

Date

12/2013

Returns

true if the target TextParaInspector object is empty, false otherwise

justification()

virtual ParagraphJustificationVector hdi::core::TextParaInspector::justification ( ) const

virtual

Retrieves the justification values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of justification settings for each paragraph being inspected

leadingType()

virtual LeadingTypeVector hdi::core::TextParaInspector::leadingType ( ) const

virtual

Retrieves the leading types from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of leading types for each paragraph being inspected

maxGlyphScaling()

virtual DoubleVector hdi::core::TextParaInspector::maxGlyphScaling ( ) const

virtual

Retrieves the max glyph scaling values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of max glyph scalings for each paragraph being inspected

maxLetterSpacing()

virtual DoubleVector hdi::core::TextParaInspector::maxLetterSpacing ( ) const

virtual

Retrieves the max letter spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of max letter spacings for each paragraph being inspected

maxWordSpacing()

virtual DoubleVector hdi::core::TextParaInspector::maxWordSpacing ( ) const

virtual

Retrieves the max word spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of max word spacings for each paragraph being inspected

minGlyphScaling()

virtual DoubleVector hdi::core::TextParaInspector::minGlyphScaling ( ) const

virtual

Retrieves the min glyph scaling values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of min glyph scalings for each paragraph being inspected

minLetterSpacing()

virtual DoubleVector hdi::core::TextParaInspector::minLetterSpacing ( ) const

virtual

Retrieves the min letter spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of min letter spacings for each paragraph being inspected

minWordSpacing()

virtual DoubleVector hdi::core::TextParaInspector::minWordSpacing ( ) const

virtual

Retrieves the min word spacing values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of min word spacings for each paragraph being inspected

operator!=()

virtual bool hdi::core::TextParaInspector::operator!= ( const TextParaInspector & rhs_ ) const

virtual

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

Author

GW

Date

12/2013

Parameters

rhs_	TextParaInspector to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different text char inspectors, false otherwise

operator=()

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

virtual

Overloaded assignment operator for TextParaInspector objects.

Author

GW

Date

12/2013

Parameters

rhs_	Existing TextParaInspector object to copy values from

Returns

The target TextParaInspector object, but with its values updated to match that of rhs_

operator==()

virtual bool hdi::core::TextParaInspector::operator== ( const TextParaInspector & rhs_ ) const

virtual

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

Author

GW

Date

12/2013

Parameters

rhs_	TextParaInspector to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same text char inspector, false otherwise

postHyphenSize()

virtual IntVector hdi::core::TextParaInspector::postHyphenSize ( ) const

virtual

Retrieves the post-hyphen size values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of post-hyphen sizes for each paragraph being inspected

preHyphenSize()

virtual IntVector hdi::core::TextParaInspector::preHyphenSize ( ) const

virtual

Retrieves the pre-hyphen size values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of pre-hyphen sizes for each paragraph being inspected

singleWordJustification()

virtual ParagraphJustificationVector hdi::core::TextParaInspector::singleWordJustification ( ) const

virtual

Retrieves the single-word justification values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of single-word justifications for each paragraph being inspected

spaceAfter()

virtual DoubleVector hdi::core::TextParaInspector::spaceAfter ( ) const

virtual

Retrieves the space-after values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of space-after settings for each paragraph being inspected

spaceBefore()

virtual DoubleVector hdi::core::TextParaInspector::spaceBefore ( ) const

virtual

Retrieves the space-before values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of space-before settings for each paragraph being inspected

startIndent()

virtual DoubleVector hdi::core::TextParaInspector::startIndent ( ) const

virtual

Retrieves the start-indent values from the paragraph set.

Author

GW

Date

12/2013

Returns

A vector of start-indent settings for each paragraph being inspected