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

Allows for easy manipulation of Illustrator text paragraph features. More...

#include <hdicoreTextParaFeatures.h>

Public Member Functions

 TextParaFeatures ()
 Creates a new TextParaFeatures object. More...
 
 TextParaFeatures (const TextParaFeatures &pf_)
 TextParaFeatures copy constructor. More...
 
virtual ~TextParaFeatures ()
 Destructs a TextParaFeatures object. More...
 
virtual TextParaFeaturesoperator= (const TextParaFeatures &rhs_)
 Overloaded assignment operator for TextParaFeatures objects. More...
 
virtual bool operator== (const TextParaFeatures &rhs_) const
 Tests whether a given TextParaFeatures object is the same as another. More...
 
virtual bool operator!= (const TextParaFeatures &rhs_) const
 Tests whether a given TextParaFeatures object is not the same as another. More...
 
virtual std::auto_ptr< ATE::IParaFeatures > ateParaFeatures () const
 Gets the ATE paragraph features ref around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target TextParaFeatures object is empty. More...
 
virtual std::auto_ptr< TextParaFeaturesduplicate () const
 Duplicates the target object. More...
 
virtual bool justification (ParagraphJustification &just__) const
 Retrieves the justification attribute of this paragraph. More...
 
virtual bool firstLineIndent (double &indent__) const
 Retrieves the first-line indent attribute of this paragraph. More...
 
virtual bool startIndent (double &indent__) const
 Retrieves the paragraph start indent attribute of this paragraph. More...
 
virtual bool endIndent (double &indent__) const
 Retrieves the paragraph end indent attribute of this paragraph. More...
 
virtual bool spaceBefore (double &space__) const
 Retrieves the line space before attribute of this paragraph. More...
 
virtual bool spaceAfter (double &space__) const
 Retrieves the line space after attribute of this paragraph. More...
 
virtual bool autoHyphenate (bool &hyphen__) const
 Retrieves the automatic hyphenation attribute of this paragraph. More...
 
virtual bool hyphenatedWordSize (int32_t &size__) const
 Retrieves the hyphenation word size attribute of this paragraph. More...
 
virtual bool preHyphenSize (int32_t &size__) const
 Retrieves the pre-hyphen size attribute of this paragraph. More...
 
virtual bool postHyphenSize (int32_t &size__) const
 Retrieves the post-hyphen size attribute of this paragraph. More...
 
virtual bool consecutiveHyphenLimit (int32_t &limit__) const
 Retrieves the consecutive hyphen limit attribute of this paragraph. More...
 
virtual bool hyphenationZone (double &zone__) const
 Retrieves the hyphenation zone attribute of this paragraph. More...
 
virtual bool hyphenateCapitalized (bool &cap__) const
 Retrieves the hyphenation capitalization attribute of this paragraph. More...
 
virtual bool hyphenationPreference (double &pref__) const
 Retrieves the hyphenation preference attribute of this paragraph. More...
 
virtual bool desiredWordSpacing (double &space__) const
 Retrieves the desired word spacing attribute of this paragraph. More...
 
virtual bool minWordSpacing (double &space__) const
 Retrieves the minimum word spacing attribute of this paragraph. More...
 
virtual bool maxWordSpacing (double &space__) const
 Retrieves the maximum word spacing attribute of this paragraph. More...
 
virtual bool desiredLetterSpacing (double &space__) const
 Retrieves the desired letter spacing attribute of this paragraph. More...
 
virtual bool minLetterSpacing (double &space__) const
 Retrieves the minimum letter spacing attribute of this paragraph. More...
 
virtual bool maxLetterSpacing (double &space__) const
 Retrieves the maximum letter spacing attribute of this paragraph. More...
 
virtual bool desiredGlyphScaling (double &scale__) const
 Retrieves the desired glyph scaling attribute of this paragraph. More...
 
virtual bool minGlyphScaling (double &scale__) const
 Retrieves the minimum glyph scaling attribute of this paragraph. More...
 
virtual bool maxGlyphScaling (double &scale__) const
 Retrieves the maximum glyph scaling attribute of this paragraph. More...
 
virtual bool singleWordJustification (ParagraphJustification &just__) const
 Retrieves the single-word justification attribute of this paragraph. More...
 
virtual bool autoLeadingPercentage (double &perc__) const
 Retrieves the automatic leading percentage attribute of this paragraph. More...
 
virtual bool leadingType (LeadingType &type__) const
 Retrieves the leading type attribute of this paragraph. More...
 
virtual bool tabStops (TextTabStopSet &stops__) const
 Retrieves the tab stops attribute of this paragraph. More...
 
virtual bool defaultTabWidth (double &width__) const
 Retrieves the default tab width attribute of this paragraph. More...
 
virtual bool everyLineComposer (bool &comp__) const
 Retrieves the every-line composer attribute of this paragraph. More...
 
virtual bool defaultCharFeatures (TextCharFeatures &feat__) const
 Retrieves the default character features attribute of this paragraph. More...
 
virtual bool composerEngine (ComposerEngine &engine__) const
 Retrieves the composer engine attribute of this paragraph. More...
 
virtual void setJustification (const ParagraphJustification just_)
 Sets the local justification attribute of this paragraph. More...
 
virtual void setFirstLineIndent (const double indent_)
 Sets the local first-line indent attribute of this paragraph. More...
 
virtual void setStartIndent (const double indent_)
 Sets the local start indent attribute of this paragraph. More...
 
virtual void setEndIndent (const double indent_)
 Sets the local end indent attribute of this paragraph. More...
 
virtual void setSpaceBefore (const double space_)
 Sets the local line space before attribute of this paragraph. More...
 
virtual void setSpaceAfter (const double space_)
 Sets the local line space after attribute of this paragraph. More...
 
virtual void setAutoHyphenate (const bool hyphen_)
 Sets the local automatic hyphenation attribute of this paragraph. More...
 
virtual void setHyphenatedWordSize (const int32_t size_)
 Sets the local hyphenated word size attribute of this paragraph. More...
 
virtual void setPreHyphenSize (const int32_t size_)
 Sets the local pre-hyphen size attribute of this paragraph. More...
 
virtual void setPostHyphenSize (const int32_t size_)
 Sets the local post-hyphen size attribute of this paragraph. More...
 
virtual void setConsecutiveHyphenLimit (const int32_t limit_)
 Sets the local consecutive hyphen limit attribute of this paragraph. More...
 
virtual void setHyphenationZone (const double zone_)
 Sets the local hyphenation zone attribute of this paragraph. More...
 
virtual void setHyphenateCapitalized (const bool cap_)
 Sets the local hyphenation capitalized attribute of this paragraph. More...
 
virtual void setHyphenationPreference (const double pref_)
 Sets the local hyphenation preference attribute of this paragraph. More...
 
virtual void setDesiredWordSpacing (const double space_)
 Sets the local desired word spacing attribute of this paragraph. More...
 
virtual void setMinWordSpacing (const double space_)
 Sets the local minimum word spacing attribute of this paragraph. More...
 
virtual void setMaxWordSpacing (const double space_)
 Sets the local maximum word spacing attribute of this paragraph. More...
 
virtual void setDesiredLetterSpacing (const double space_)
 Sets the local desired letter spacing attribute of this paragraph. More...
 
virtual void setMinLetterSpacing (const double space_)
 Sets the local minimum letter spacing attribute of this paragraph. More...
 
virtual void setMaxLetterSpacing (const double space_)
 Sets the local maximum letter spacing attribute of this paragraph. More...
 
virtual void setDesiredGlyphScaling (const double scale_)
 Sets the local desired glyph scaling attribute of this paragraph. More...
 
virtual void setMinGlyphScaling (const double scale_)
 Sets the local minimum glyph scaling attribute of this paragraph. More...
 
virtual void setMaxGlyphScaling (const double scale_)
 Sets the local maximum glyph scaling attribute of this paragraph. More...
 
virtual void setSingleWordJustification (const ParagraphJustification just_)
 Sets the local single-word justification attribute of this paragraph. More...
 
virtual void setAutoLeadingPercentage (const double perc_)
 Sets the local automatic leading percentage attribute of this paragraph. More...
 
virtual void setLeadingType (const LeadingType type_)
 Sets the local leading type attribute of this paragraph. More...
 
virtual void setTabStops (const TextTabStopSet &stops_)
 Sets the local tab stops attribute of this paragraph. More...
 
virtual void setDefaultTabWidth (const double width_)
 Sets the local default tab width attribute of this paragraph. More...
 
virtual void setEveryLineComposer (const bool comp_)
 Sets the local every-line composer attribute of this paragraph. More...
 
virtual void setDefaultCharFeatures (const TextCharFeatures &feat_)
 Sets the local default character features attribute of this paragraph. More...
 
virtual void setComposerEngine (const ComposerEngine engine_)
 Sets the composer engine attribute of this paragraph. More...
 
virtual void clearJustification ()
 Removes the local justification attribute value of this paragraph. More...
 
virtual void clearFirstLineIndent ()
 Removes the local first-line indent attribute value of this paragraph. More...
 
virtual void clearStartIndent ()
 Removes the local start indent attribute value of this paragraph. More...
 
virtual void clearEndIndent ()
 Removes the local end indent attribute value of this paragraph. More...
 
virtual void clearSpaceBefore ()
 Removes the local line space before attribute value of this paragraph. More...
 
virtual void clearSpaceAfter ()
 Removes the local line space after attribute value of this paragraph. More...
 
virtual void clearAutoHyphenate ()
 Removes the local automatic hyphenation attribute value of this paragraph. More...
 
virtual void clearHyphenatedWordSize ()
 Removes the local hyphenation word size attribute value of this paragraph. More...
 
virtual void clearPreHyphenSize ()
 Removes the local pre-hyphen size attribute value of this paragraph. More...
 
virtual void clearPostHyphenSize ()
 Removes the local post-hyphen size attribute value of this paragraph. More...
 
virtual void clearConsecutiveHyphenLimit ()
 Removes the local consecutive hyphen limit attribute value of this paragraph. More...
 
virtual void clearHyphenationZone ()
 Removes the local hyphenation zone attribute value of this paragraph. More...
 
virtual void clearHyphenateCapitalized ()
 Removes the local hyphenate capitalized attribute value of this paragraph. More...
 
virtual void clearHyphenationPreference ()
 Removes the local hyphenation preference attribute value of this paragraph. More...
 
virtual void clearWordSpacing ()
 Removes all of the local word spacing attribute values of this paragraph. More...
 
virtual void clearLetterSpacing ()
 Removes all of the local letter spacing attribute values of this paragraph. More...
 
virtual void clearGlyphScaling ()
 Removes all of the local glyph scaling attribute values of this paragraph. More...
 
virtual void clearSingleWordJustification ()
 Removes the local single-word justification attribute value of this paragraph. More...
 
virtual void clearAutoLeadingPercentage ()
 Removes the local automatic leading percentage attribute value of this paragraph. More...
 
virtual void clearLeadingType ()
 Removes the local leading type attribute value of this paragraph. More...
 
virtual void clearTabStops ()
 Removes the local tab stops attribute value of this paragraph. More...
 
virtual void clearEveryLineComposer ()
 Removes the local every-line composer attribute value of this paragraph. More...
 
virtual void clearDefaultCharFeatures ()
 Removes the local default character features attribute value of this paragraph. More...
 
virtual void clearComposerEngine ()
 Removes the composer engine attribute value of this paragraph. More...
 

Friends

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

Detailed Description

Allows for easy manipulation of Illustrator text paragraph features.

Constructor & Destructor Documentation

hdi::core::TextParaFeatures::TextParaFeatures ( )

Creates a new TextParaFeatures object.

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

TextParaFeatures copy constructor.

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

Destructs a TextParaFeatures object.

Author
GW
Date
08/2014

Member Function Documentation

virtual std::auto_ptr<ATE::IParaFeatures> hdi::core::TextParaFeatures::ateParaFeatures ( ) const
virtual

Gets the ATE paragraph features ref around which the target object is wrapped.

Author
GW
Date
08/2014
Returns
ATE::IParaFeatures 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 bool hdi::core::TextParaFeatures::autoHyphenate ( bool &  hyphen__) const
virtual

Retrieves the automatic hyphenation attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
hyphen__Return-by-reference for true if automatic hyphenation is on, false if it is off
Returns
true if the attribute could be acquired and hyphen__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::autoLeadingPercentage ( double &  perc__) const
virtual

Retrieves the automatic leading percentage attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
perc__Return-by-reference for the automatic leading percentage value, where 1.0 is 100.0%
Returns
true if the attribute could be acquired and perc__ was set, false otherwise
virtual void hdi::core::TextParaFeatures::clearAutoHyphenate ( )
virtual

Removes the local automatic hyphenation attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearAutoLeadingPercentage ( )
virtual

Removes the local automatic leading percentage attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearComposerEngine ( )
virtual

Removes the composer engine attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearConsecutiveHyphenLimit ( )
virtual

Removes the local consecutive hyphen limit attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearDefaultCharFeatures ( )
virtual

Removes the local default character features attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearEndIndent ( )
virtual

Removes the local end indent attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearEveryLineComposer ( )
virtual

Removes the local every-line composer attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearFirstLineIndent ( )
virtual

Removes the local first-line indent attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearGlyphScaling ( )
virtual

Removes all of the local glyph scaling attribute values of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearHyphenateCapitalized ( )
virtual

Removes the local hyphenate capitalized attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearHyphenatedWordSize ( )
virtual

Removes the local hyphenation word size attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearHyphenationPreference ( )
virtual

Removes the local hyphenation preference attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearHyphenationZone ( )
virtual

Removes the local hyphenation zone attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearJustification ( )
virtual

Removes the local justification attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearLeadingType ( )
virtual

Removes the local leading type attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearLetterSpacing ( )
virtual

Removes all of the local letter spacing attribute values of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearPostHyphenSize ( )
virtual

Removes the local post-hyphen size attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearPreHyphenSize ( )
virtual

Removes the local pre-hyphen size attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearSingleWordJustification ( )
virtual

Removes the local single-word justification attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearSpaceAfter ( )
virtual

Removes the local line space after attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearSpaceBefore ( )
virtual

Removes the local line space before attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearStartIndent ( )
virtual

Removes the local start indent attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearTabStops ( )
virtual

Removes the local tab stops attribute value of this paragraph.

Author
GW
Date
08/2014
virtual void hdi::core::TextParaFeatures::clearWordSpacing ( )
virtual

Removes all of the local word spacing attribute values of this paragraph.

Author
GW
Date
08/2014
virtual bool hdi::core::TextParaFeatures::composerEngine ( ComposerEngine &  engine__) const
virtual

Retrieves the composer engine attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
engine__Return-by-reference for the composer engine object
Returns
true if the attribute could be acquired and engine__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::consecutiveHyphenLimit ( int32_t &  limit__) const
virtual

Retrieves the consecutive hyphen limit attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
limit__Return-by-reference for the consecutive hyphen limit value (number of hyphens)
Returns
true if the attribute could be acquired and limit__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::defaultCharFeatures ( TextCharFeatures feat__) const
virtual

Retrieves the default character features attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
feat__Return-by-reference for the character features object
Returns
true if the attribute could be acquired and feat__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::defaultTabWidth ( double &  width__) const
virtual

Retrieves the default tab width attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
width__Return-by-reference for the default tab width value, in document points
Returns
true if the attribute could be acquired and width__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::desiredGlyphScaling ( double &  scale__) const
virtual

Retrieves the desired glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale__Return-by-reference for the desired glyph scaling value, where 1.0 is 100.0%
Returns
true if the attribute could be acquired and scale__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::desiredLetterSpacing ( double &  space__) const
virtual

Retrieves the desired letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the desired letter spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::desiredWordSpacing ( double &  space__) const
virtual

Retrieves the desired word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the desired word spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual std::auto_ptr<TextParaFeatures> hdi::core::TextParaFeatures::duplicate ( ) const
virtual

Duplicates the target object.

Author
GW
Date
08/2014
Returns
A duplicate of the target object, or NULL for error
virtual bool hdi::core::TextParaFeatures::endIndent ( double &  indent__) const
virtual

Retrieves the paragraph end indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent__Return-by-reference for the end indent value in document points
Returns
true if the attribute could be acquired and indent__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::everyLineComposer ( bool &  comp__) const
virtual

Retrieves the every-line composer attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
comp__Return-by-reference for true if every-line composer is on, false if it is off
Returns
true if the attribute could be acquired and comp__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::firstLineIndent ( double &  indent__) const
virtual

Retrieves the first-line indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent__The first-line indent value in document points
Returns
true if the attribute could be acquired and indent__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::hyphenateCapitalized ( bool &  cap__) const
virtual

Retrieves the hyphenation capitalization attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
cap__Return-by-reference for true if hyphenation capitalization is on, false if it is off
Returns
true if the attribute could be acquired and cap__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::hyphenatedWordSize ( int32_t &  size__) const
virtual

Retrieves the hyphenation word size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size__Return-by-reference for the hyphenation word size value (number of characters)
Returns
true if the attribute could be acquired and size__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::hyphenationPreference ( double &  pref__) const
virtual

Retrieves the hyphenation preference attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
pref__Return-by-reference for the hyphenation preference value
Returns
true if the attribute could be acquired and pref__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::hyphenationZone ( double &  zone__) const
virtual

Retrieves the hyphenation zone attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
zone__Return-by-reference for the hyphenation zone value in document points
Returns
true if the attribute could be acquired and zone__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::isEmpty ( ) const
virtual

Gets whether the target TextParaFeatures object is empty.

Author
GW
Date
08/2014
Returns
true if the target TextParaFeatures object is empty, false otherwise
virtual bool hdi::core::TextParaFeatures::justification ( ParagraphJustification &  just__) const
virtual

Retrieves the justification attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
just__Return-by-reference for the justification enum value
Returns
true if the attribute could be acquired and just__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::leadingType ( LeadingType &  type__) const
virtual

Retrieves the leading type attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
type__Return-by-reference for the leading type
Returns
true if the attribute could be acquired and type__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::maxGlyphScaling ( double &  scale__) const
virtual

Retrieves the maximum glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale__Return-by-reference for the maximum glyph scaling value, where 1.0 is 100.0%
Returns
true if the attribute could be acquired and scale__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::maxLetterSpacing ( double &  space__) const
virtual

Retrieves the maximum letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the maximum letter spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::maxWordSpacing ( double &  space__) const
virtual

Retrieves the maximum word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the maximum word spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::minGlyphScaling ( double &  scale__) const
virtual

Retrieves the minimum glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale__Return-by-reference for the minimum glyph scaling value, where 1.0 is 100.0%
Returns
true if the attribute could be acquired and scale__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::minLetterSpacing ( double &  space__) const
virtual

Retrieves the minimum letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the minimum letter spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::minWordSpacing ( double &  space__) const
virtual

Retrieves the minimum word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the minimum word spacing value, in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::operator!= ( const TextParaFeatures rhs_) const
virtual

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

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

Overloaded assignment operator for TextParaFeatures objects.

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

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

Author
GW
Date
08/2014
Parameters
rhs_TextParaFeatures to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same text paragraph features, false otherwise
virtual bool hdi::core::TextParaFeatures::postHyphenSize ( int32_t &  size__) const
virtual

Retrieves the post-hyphen size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size__Return-by-reference for the post-hyphen size value (number of characters)
Returns
true if the attribute could be acquired and size__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::preHyphenSize ( int32_t &  size__) const
virtual

Retrieves the pre-hyphen size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size__Return-by-reference for the pre-hyphen size value (number of characters)
Returns
true if the attribute could be acquired and size__ was set, false otherwise
virtual void hdi::core::TextParaFeatures::setAutoHyphenate ( const bool  hyphen_)
virtual

Sets the local automatic hyphenation attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
hyphen_true to turn automatic hyphenation on, false to turn it off
virtual void hdi::core::TextParaFeatures::setAutoLeadingPercentage ( const double  perc_)
virtual

Sets the local automatic leading percentage attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
perc_The new automatic leading percentage value, where 1.0 is 100.0%
virtual void hdi::core::TextParaFeatures::setComposerEngine ( const ComposerEngine  engine_)
virtual

Sets the composer engine attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
engine_The new composer engine object
virtual void hdi::core::TextParaFeatures::setConsecutiveHyphenLimit ( const int32_t  limit_)
virtual

Sets the local consecutive hyphen limit attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
limit_The new consecutive hyphen limit value, a number of hyphens
virtual void hdi::core::TextParaFeatures::setDefaultCharFeatures ( const TextCharFeatures feat_)
virtual

Sets the local default character features attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
feat_The new default character features object
virtual void hdi::core::TextParaFeatures::setDefaultTabWidth ( const double  width_)
virtual

Sets the local default tab width attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
width_The new default tab width value, in document points
virtual void hdi::core::TextParaFeatures::setDesiredGlyphScaling ( const double  scale_)
virtual

Sets the local desired glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale_The new desired glyph scaling value, where 1.0 is 100.0%
virtual void hdi::core::TextParaFeatures::setDesiredLetterSpacing ( const double  space_)
virtual

Sets the local desired letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new desired letter spacing value, in document points
virtual void hdi::core::TextParaFeatures::setDesiredWordSpacing ( const double  space_)
virtual

Sets the local desired word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new desired word spacing value, in document points
virtual void hdi::core::TextParaFeatures::setEndIndent ( const double  indent_)
virtual

Sets the local end indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent_The new end indent value, in document points
virtual void hdi::core::TextParaFeatures::setEveryLineComposer ( const bool  comp_)
virtual

Sets the local every-line composer attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
comp_true to turn every-line composer on, false to turn it off
virtual void hdi::core::TextParaFeatures::setFirstLineIndent ( const double  indent_)
virtual

Sets the local first-line indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent_The new first-line indent value, in document points
virtual void hdi::core::TextParaFeatures::setHyphenateCapitalized ( const bool  cap_)
virtual

Sets the local hyphenation capitalized attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
cap_true to turn hyphenation capitalized on, false to turn it off
virtual void hdi::core::TextParaFeatures::setHyphenatedWordSize ( const int32_t  size_)
virtual

Sets the local hyphenated word size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size_The new hyphenated word size value, in characters
virtual void hdi::core::TextParaFeatures::setHyphenationPreference ( const double  pref_)
virtual

Sets the local hyphenation preference attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
pref_The new hyphenation preference value
virtual void hdi::core::TextParaFeatures::setHyphenationZone ( const double  zone_)
virtual

Sets the local hyphenation zone attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
zone_The new hyphenation zone value, in document points
virtual void hdi::core::TextParaFeatures::setJustification ( const ParagraphJustification  just_)
virtual

Sets the local justification attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
just_The new justification type
virtual void hdi::core::TextParaFeatures::setLeadingType ( const LeadingType  type_)
virtual

Sets the local leading type attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
type_The new leading type
virtual void hdi::core::TextParaFeatures::setMaxGlyphScaling ( const double  scale_)
virtual

Sets the local maximum glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale_The new maximum glyph scaling value, where 1.0 is 100.0%
virtual void hdi::core::TextParaFeatures::setMaxLetterSpacing ( const double  space_)
virtual

Sets the local maximum letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new maximum letter spacing value, in document points
virtual void hdi::core::TextParaFeatures::setMaxWordSpacing ( const double  space_)
virtual

Sets the local maximum word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new maximum word spacing value, in document points
virtual void hdi::core::TextParaFeatures::setMinGlyphScaling ( const double  scale_)
virtual

Sets the local minimum glyph scaling attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
scale_The new minimum glyph scaling value, where 1.0 is 100.0%
virtual void hdi::core::TextParaFeatures::setMinLetterSpacing ( const double  space_)
virtual

Sets the local minimum letter spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new minimum letter spacing value, in document points
virtual void hdi::core::TextParaFeatures::setMinWordSpacing ( const double  space_)
virtual

Sets the local minimum word spacing attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new minimum word spacing value, in document points
virtual void hdi::core::TextParaFeatures::setPostHyphenSize ( const int32_t  size_)
virtual

Sets the local post-hyphen size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size_The new post-hyphen size value, in characters
virtual void hdi::core::TextParaFeatures::setPreHyphenSize ( const int32_t  size_)
virtual

Sets the local pre-hyphen size attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
size_The new pre-hyphen size value, in characters
virtual void hdi::core::TextParaFeatures::setSingleWordJustification ( const ParagraphJustification  just_)
virtual

Sets the local single-word justification attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
just_The new single-word justification type
virtual void hdi::core::TextParaFeatures::setSpaceAfter ( const double  space_)
virtual

Sets the local line space after attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new line space after value, in document points
virtual void hdi::core::TextParaFeatures::setSpaceBefore ( const double  space_)
virtual

Sets the local line space before attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space_The new line space before value, in document points
virtual void hdi::core::TextParaFeatures::setStartIndent ( const double  indent_)
virtual

Sets the local start indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent_The new start indent value, in document points
virtual void hdi::core::TextParaFeatures::setTabStops ( const TextTabStopSet stops_)
virtual

Sets the local tab stops attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
stops_The new tab stops object
virtual bool hdi::core::TextParaFeatures::singleWordJustification ( ParagraphJustification &  just__) const
virtual

Retrieves the single-word justification attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
just__Return-by-reference for the single-word justification type
Returns
true if the attribute could be acquired and just__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::spaceAfter ( double &  space__) const
virtual

Retrieves the line space after attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the line space after value in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::spaceBefore ( double &  space__) const
virtual

Retrieves the line space before attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
space__Return-by-reference for the line space before value in document points
Returns
true if the attribute could be acquired and space__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::startIndent ( double &  indent__) const
virtual

Retrieves the paragraph start indent attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
indent__Return-by-reference for the start indent value in document points
Returns
true if the attribute could be acquired and indent__ was set, false otherwise
virtual bool hdi::core::TextParaFeatures::tabStops ( TextTabStopSet stops__) const
virtual

Retrieves the tab stops attribute of this paragraph.

Author
GW
Date
08/2014
Parameters
stops__Return-by-reference for the tab stops object
Returns
true if the attribute could be acquired and stops__ was set, false otherwise