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

Friends

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

Detailed Description

Allows for easy inspection of Illustrator text characters.

Constructor & Destructor Documentation

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.
hdi::core::TextParaInspector::TextParaInspector ( const TextParaInspector pi_)

TextParaInspector copy constructor.

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

Destructs a TextParaInspector object.

Author
GW
Date
12/2013

Member Function Documentation

virtual std::auto_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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
virtual TextParaInspector& hdi::core::TextParaInspector::operator= ( const TextParaInspector rhs_)
virtual

Overloaded assignment operator for TextParaInspector objects.

Author
GW
Date
12/2013
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
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
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
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
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
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
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