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

#include <hdicoreTextParaFeatures.h>

Public Member Functions
	TextParaFeatures ()
	Creates a new TextParaFeatures object.

	TextParaFeatures (const TextParaFeatures &pf_)
	TextParaFeatures copy constructor.

virtual	~TextParaFeatures ()
	Destructs a TextParaFeatures object.

virtual TextParaFeatures &	operator= (const TextParaFeatures &rhs_)
	Overloaded assignment operator for TextParaFeatures objects.

virtual bool	operator== (const TextParaFeatures &rhs_) const
	Tests whether a given TextParaFeatures object is the same as another.

virtual bool	operator!= (const TextParaFeatures &rhs_) const
	Tests whether a given TextParaFeatures object is not the same as another.

virtual std::unique_ptr< ATE::IParaFeatures >	ateParaFeatures () const
	Gets the ATE paragraph features ref around which the target object is wrapped.

virtual bool	isEmpty () const
	Gets whether the target TextParaFeatures object is empty.

virtual std::unique_ptr< TextParaFeatures >	duplicate () const
	Duplicates the target object.

virtual bool	justification (ParagraphJustification &just__) const
	Retrieves the justification attribute of this paragraph.

virtual bool	firstLineIndent (double &indent__) const
	Retrieves the first-line indent attribute of this paragraph.

virtual bool	startIndent (double &indent__) const
	Retrieves the paragraph start indent attribute of this paragraph.

virtual bool	endIndent (double &indent__) const
	Retrieves the paragraph end indent attribute of this paragraph.

virtual bool	spaceBefore (double &space__) const
	Retrieves the line space before attribute of this paragraph.

virtual bool	spaceAfter (double &space__) const
	Retrieves the line space after attribute of this paragraph.

virtual bool	autoHyphenate (bool &hyphen__) const
	Retrieves the automatic hyphenation attribute of this paragraph.

virtual bool	hyphenatedWordSize (int32_t &size__) const
	Retrieves the hyphenation word size attribute of this paragraph.

virtual bool	preHyphenSize (int32_t &size__) const
	Retrieves the pre-hyphen size attribute of this paragraph.

virtual bool	postHyphenSize (int32_t &size__) const
	Retrieves the post-hyphen size attribute of this paragraph.

virtual bool	consecutiveHyphenLimit (int32_t &limit__) const
	Retrieves the consecutive hyphen limit attribute of this paragraph.

virtual bool	hyphenationZone (double &zone__) const
	Retrieves the hyphenation zone attribute of this paragraph.

virtual bool	hyphenateCapitalized (bool &cap__) const
	Retrieves the hyphenation capitalization attribute of this paragraph.

virtual bool	hyphenationPreference (double &pref__) const
	Retrieves the hyphenation preference attribute of this paragraph.

virtual bool	desiredWordSpacing (double &space__) const
	Retrieves the desired word spacing attribute of this paragraph.

virtual bool	minWordSpacing (double &space__) const
	Retrieves the minimum word spacing attribute of this paragraph.

virtual bool	maxWordSpacing (double &space__) const
	Retrieves the maximum word spacing attribute of this paragraph.

virtual bool	desiredLetterSpacing (double &space__) const
	Retrieves the desired letter spacing attribute of this paragraph.

virtual bool	minLetterSpacing (double &space__) const
	Retrieves the minimum letter spacing attribute of this paragraph.

virtual bool	maxLetterSpacing (double &space__) const
	Retrieves the maximum letter spacing attribute of this paragraph.

virtual bool	desiredGlyphScaling (double &scale__) const
	Retrieves the desired glyph scaling attribute of this paragraph.

virtual bool	minGlyphScaling (double &scale__) const
	Retrieves the minimum glyph scaling attribute of this paragraph.

virtual bool	maxGlyphScaling (double &scale__) const
	Retrieves the maximum glyph scaling attribute of this paragraph.

virtual bool	singleWordJustification (ParagraphJustification &just__) const
	Retrieves the single-word justification attribute of this paragraph.

virtual bool	autoLeadingPercentage (double &perc__) const
	Retrieves the automatic leading percentage attribute of this paragraph.

virtual bool	leadingType (LeadingType &type__) const
	Retrieves the leading type attribute of this paragraph.

virtual bool	tabStops (TextTabStopSet &stops__) const
	Retrieves the tab stops attribute of this paragraph.

virtual bool	defaultTabWidth (double &width__) const
	Retrieves the default tab width attribute of this paragraph.

virtual bool	everyLineComposer (bool &comp__) const
	Retrieves the every-line composer attribute of this paragraph.

virtual bool	defaultCharFeatures (TextCharFeatures &feat__) const
	Retrieves the default character features attribute of this paragraph.

virtual bool	composerEngine (ComposerEngine &engine__) const
	Retrieves the composer engine attribute of this paragraph.

virtual void	setJustification (const ParagraphJustification just_)
	Sets the local justification attribute of this paragraph.

virtual void	setFirstLineIndent (const double indent_)
	Sets the local first-line indent attribute of this paragraph.

virtual void	setStartIndent (const double indent_)
	Sets the local start indent attribute of this paragraph.

virtual void	setEndIndent (const double indent_)
	Sets the local end indent attribute of this paragraph.

virtual void	setSpaceBefore (const double space_)
	Sets the local line space before attribute of this paragraph.

virtual void	setSpaceAfter (const double space_)
	Sets the local line space after attribute of this paragraph.

virtual void	setAutoHyphenate (const bool hyphen_)
	Sets the local automatic hyphenation attribute of this paragraph.

virtual void	setHyphenatedWordSize (const int32_t size_)
	Sets the local hyphenated word size attribute of this paragraph.

virtual void	setPreHyphenSize (const int32_t size_)
	Sets the local pre-hyphen size attribute of this paragraph.

virtual void	setPostHyphenSize (const int32_t size_)
	Sets the local post-hyphen size attribute of this paragraph.

virtual void	setConsecutiveHyphenLimit (const int32_t limit_)
	Sets the local consecutive hyphen limit attribute of this paragraph.

virtual void	setHyphenationZone (const double zone_)
	Sets the local hyphenation zone attribute of this paragraph.

virtual void	setHyphenateCapitalized (const bool cap_)
	Sets the local hyphenation capitalized attribute of this paragraph.

virtual void	setHyphenationPreference (const double pref_)
	Sets the local hyphenation preference attribute of this paragraph.

virtual void	setDesiredWordSpacing (const double space_)
	Sets the local desired word spacing attribute of this paragraph.

virtual void	setMinWordSpacing (const double space_)
	Sets the local minimum word spacing attribute of this paragraph.

virtual void	setMaxWordSpacing (const double space_)
	Sets the local maximum word spacing attribute of this paragraph.

virtual void	setDesiredLetterSpacing (const double space_)
	Sets the local desired letter spacing attribute of this paragraph.

virtual void	setMinLetterSpacing (const double space_)
	Sets the local minimum letter spacing attribute of this paragraph.

virtual void	setMaxLetterSpacing (const double space_)
	Sets the local maximum letter spacing attribute of this paragraph.

virtual void	setDesiredGlyphScaling (const double scale_)
	Sets the local desired glyph scaling attribute of this paragraph.

virtual void	setMinGlyphScaling (const double scale_)
	Sets the local minimum glyph scaling attribute of this paragraph.

virtual void	setMaxGlyphScaling (const double scale_)
	Sets the local maximum glyph scaling attribute of this paragraph.

virtual void	setSingleWordJustification (const ParagraphJustification just_)
	Sets the local single-word justification attribute of this paragraph.

virtual void	setAutoLeadingPercentage (const double perc_)
	Sets the local automatic leading percentage attribute of this paragraph.

virtual void	setLeadingType (const LeadingType type_)
	Sets the local leading type attribute of this paragraph.

virtual void	setTabStops (const TextTabStopSet &stops_)
	Sets the local tab stops attribute of this paragraph.

virtual void	setDefaultTabWidth (const double width_)
	Sets the local default tab width attribute of this paragraph.

virtual void	setEveryLineComposer (const bool comp_)
	Sets the local every-line composer attribute of this paragraph.

virtual void	setDefaultCharFeatures (const TextCharFeatures &feat_)
	Sets the local default character features attribute of this paragraph.

virtual void	setComposerEngine (const ComposerEngine engine_)
	Sets the composer engine attribute of this paragraph.

virtual void	clearJustification ()
	Removes the local justification attribute value of this paragraph.

virtual void	clearFirstLineIndent ()
	Removes the local first-line indent attribute value of this paragraph.

virtual void	clearStartIndent ()
	Removes the local start indent attribute value of this paragraph.

virtual void	clearEndIndent ()
	Removes the local end indent attribute value of this paragraph.

virtual void	clearSpaceBefore ()
	Removes the local line space before attribute value of this paragraph.

virtual void	clearSpaceAfter ()
	Removes the local line space after attribute value of this paragraph.

virtual void	clearAutoHyphenate ()
	Removes the local automatic hyphenation attribute value of this paragraph.

virtual void	clearHyphenatedWordSize ()
	Removes the local hyphenation word size attribute value of this paragraph.

virtual void	clearPreHyphenSize ()
	Removes the local pre-hyphen size attribute value of this paragraph.

virtual void	clearPostHyphenSize ()
	Removes the local post-hyphen size attribute value of this paragraph.

virtual void	clearConsecutiveHyphenLimit ()
	Removes the local consecutive hyphen limit attribute value of this paragraph.

virtual void	clearHyphenationZone ()
	Removes the local hyphenation zone attribute value of this paragraph.

virtual void	clearHyphenateCapitalized ()
	Removes the local hyphenate capitalized attribute value of this paragraph.

virtual void	clearHyphenationPreference ()
	Removes the local hyphenation preference attribute value of this paragraph.

virtual void	clearWordSpacing ()
	Removes all of the local word spacing attribute values of this paragraph.

virtual void	clearLetterSpacing ()
	Removes all of the local letter spacing attribute values of this paragraph.

virtual void	clearGlyphScaling ()
	Removes all of the local glyph scaling attribute values of this paragraph.

virtual void	clearSingleWordJustification ()
	Removes the local single-word justification attribute value of this paragraph.

virtual void	clearAutoLeadingPercentage ()
	Removes the local automatic leading percentage attribute value of this paragraph.

virtual void	clearLeadingType ()
	Removes the local leading type attribute value of this paragraph.

virtual void	clearTabStops ()
	Removes the local tab stops attribute value of this paragraph.

virtual void	clearEveryLineComposer ()
	Removes the local every-line composer attribute value of this paragraph.

virtual void	clearDefaultCharFeatures ()
	Removes the local default character features attribute value of this paragraph.

virtual void	clearComposerEngine ()
	Removes the composer engine attribute value of this paragraph.

Friends
aip::TextParaFeatures *	__accessImpl (const TextParaFeatures &)

TextParaFeatures	__accessCtor (const aip::TextParaFeatures &)

Detailed Description

Allows for easy manipulation of Illustrator text paragraph features.

Constructor & Destructor Documentation

◆ TextParaFeatures() [1/2]

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.

◆ TextParaFeatures() [2/2]

hdi::core::TextParaFeatures::TextParaFeatures ( const TextParaFeatures & pf_ )

TextParaFeatures copy constructor.

Author: GW

Date: 08/2014

Parameters

pf_	TextParaFeatures object to copy values from

◆ ~TextParaFeatures()

virtual hdi::core::TextParaFeatures::~TextParaFeatures ( )

virtual

Destructs a TextParaFeatures object.

Author: GW

Date: 08/2014

Member Function Documentation

◆ ateParaFeatures()

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

◆ autoHyphenate()

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

◆ autoLeadingPercentage()

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

◆ clearAutoHyphenate()

virtual void hdi::core::TextParaFeatures::clearAutoHyphenate ( )

virtual

Removes the local automatic hyphenation attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearAutoLeadingPercentage()

virtual void hdi::core::TextParaFeatures::clearAutoLeadingPercentage ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearComposerEngine()

virtual void hdi::core::TextParaFeatures::clearComposerEngine ( )

virtual

Removes the composer engine attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearConsecutiveHyphenLimit()

virtual void hdi::core::TextParaFeatures::clearConsecutiveHyphenLimit ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearDefaultCharFeatures()

virtual void hdi::core::TextParaFeatures::clearDefaultCharFeatures ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearEndIndent()

virtual void hdi::core::TextParaFeatures::clearEndIndent ( )

virtual

Removes the local end indent attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearEveryLineComposer()

virtual void hdi::core::TextParaFeatures::clearEveryLineComposer ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearFirstLineIndent()

virtual void hdi::core::TextParaFeatures::clearFirstLineIndent ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearGlyphScaling()

virtual void hdi::core::TextParaFeatures::clearGlyphScaling ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearHyphenateCapitalized()

virtual void hdi::core::TextParaFeatures::clearHyphenateCapitalized ( )

virtual

Removes the local hyphenate capitalized attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearHyphenatedWordSize()

virtual void hdi::core::TextParaFeatures::clearHyphenatedWordSize ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearHyphenationPreference()

virtual void hdi::core::TextParaFeatures::clearHyphenationPreference ( )

virtual

Removes the local hyphenation preference attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearHyphenationZone()

virtual void hdi::core::TextParaFeatures::clearHyphenationZone ( )

virtual

Removes the local hyphenation zone attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearJustification()

virtual void hdi::core::TextParaFeatures::clearJustification ( )

virtual

Removes the local justification attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearLeadingType()

virtual void hdi::core::TextParaFeatures::clearLeadingType ( )

virtual

Removes the local leading type attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearLetterSpacing()

virtual void hdi::core::TextParaFeatures::clearLetterSpacing ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearPostHyphenSize()

virtual void hdi::core::TextParaFeatures::clearPostHyphenSize ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearPreHyphenSize()

virtual void hdi::core::TextParaFeatures::clearPreHyphenSize ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearSingleWordJustification()

virtual void hdi::core::TextParaFeatures::clearSingleWordJustification ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearSpaceAfter()

virtual void hdi::core::TextParaFeatures::clearSpaceAfter ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearSpaceBefore()

virtual void hdi::core::TextParaFeatures::clearSpaceBefore ( )

virtual

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

Author: GW

Date: 08/2014

◆ clearStartIndent()

virtual void hdi::core::TextParaFeatures::clearStartIndent ( )

virtual

Removes the local start indent attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearTabStops()

virtual void hdi::core::TextParaFeatures::clearTabStops ( )

virtual

Removes the local tab stops attribute value of this paragraph.

Author: GW

Date: 08/2014

◆ clearWordSpacing()

virtual void hdi::core::TextParaFeatures::clearWordSpacing ( )

virtual

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

Author: GW

Date: 08/2014

◆ composerEngine()

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

◆ consecutiveHyphenLimit()

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

◆ defaultCharFeatures()

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

◆ defaultTabWidth()

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

◆ desiredGlyphScaling()

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

◆ desiredLetterSpacing()

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

◆ desiredWordSpacing()

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

◆ duplicate()

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

◆ endIndent()

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

◆ everyLineComposer()

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

◆ firstLineIndent()

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

◆ hyphenateCapitalized()

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

◆ hyphenatedWordSize()

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

◆ hyphenationPreference()

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

◆ hyphenationZone()

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

◆ isEmpty()

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

◆ justification()

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

◆ leadingType()

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

◆ maxGlyphScaling()

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

◆ maxLetterSpacing()

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

◆ maxWordSpacing()

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

◆ minGlyphScaling()

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

◆ minLetterSpacing()

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

◆ minWordSpacing()

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

◆ operator!=()

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

◆ operator=()

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

virtual

Overloaded assignment operator for TextParaFeatures objects.

Author: GW

Date: 08/2014

◆ operator==()

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

◆ postHyphenSize()

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

◆ preHyphenSize()

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

◆ setAutoHyphenate()

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

◆ setAutoLeadingPercentage()

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%

◆ setComposerEngine()

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

◆ setConsecutiveHyphenLimit()

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

◆ setDefaultCharFeatures()

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

◆ setDefaultTabWidth()

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

◆ setDesiredGlyphScaling()

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%

◆ setDesiredLetterSpacing()

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

◆ setDesiredWordSpacing()

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

◆ setEndIndent()

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

◆ setEveryLineComposer()

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

◆ setFirstLineIndent()

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

◆ setHyphenateCapitalized()

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

◆ setHyphenatedWordSize()

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

◆ setHyphenationPreference()

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

◆ setHyphenationZone()

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

◆ setJustification()

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

◆ setLeadingType()

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

◆ setMaxGlyphScaling()

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%

◆ setMaxLetterSpacing()

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

◆ setMaxWordSpacing()

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

◆ setMinGlyphScaling()

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%

◆ setMinLetterSpacing()

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

◆ setMinWordSpacing()

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

◆ setPostHyphenSize()

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

◆ setPreHyphenSize()

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

◆ setSingleWordJustification()

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

◆ setSpaceAfter()

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

◆ setSpaceBefore()

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

◆ setStartIndent()

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

◆ setTabStops()

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

◆ singleWordJustification()

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

◆ spaceAfter()

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

◆ spaceBefore()

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

◆ startIndent()

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

◆ tabStops()

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TextParaFeatures() [1/2]

◆ TextParaFeatures() [2/2]

◆ ~TextParaFeatures()

Member Function Documentation

◆ ateParaFeatures()

◆ autoHyphenate()

◆ autoLeadingPercentage()

◆ clearAutoHyphenate()

◆ clearAutoLeadingPercentage()

◆ clearComposerEngine()

◆ clearConsecutiveHyphenLimit()

◆ clearDefaultCharFeatures()

◆ clearEndIndent()

◆ clearEveryLineComposer()

◆ clearFirstLineIndent()

◆ clearGlyphScaling()

◆ clearHyphenateCapitalized()

◆ clearHyphenatedWordSize()

◆ clearHyphenationPreference()

◆ clearHyphenationZone()

◆ clearJustification()

◆ clearLeadingType()

◆ clearLetterSpacing()

◆ clearPostHyphenSize()

◆ clearPreHyphenSize()

◆ clearSingleWordJustification()

◆ clearSpaceAfter()

◆ clearSpaceBefore()

◆ clearStartIndent()

◆ clearTabStops()

◆ clearWordSpacing()

◆ composerEngine()

◆ consecutiveHyphenLimit()

◆ defaultCharFeatures()

◆ defaultTabWidth()

◆ desiredGlyphScaling()

◆ desiredLetterSpacing()

◆ desiredWordSpacing()

◆ duplicate()

◆ endIndent()

◆ everyLineComposer()

◆ firstLineIndent()

◆ hyphenateCapitalized()

◆ hyphenatedWordSize()

◆ hyphenationPreference()

◆ hyphenationZone()

◆ isEmpty()

◆ justification()

◆ leadingType()

◆ maxGlyphScaling()

◆ maxLetterSpacing()

◆ maxWordSpacing()

◆ minGlyphScaling()

◆ minLetterSpacing()

◆ minWordSpacing()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ postHyphenSize()

◆ preHyphenSize()

◆ setAutoHyphenate()

◆ setAutoLeadingPercentage()

◆ setComposerEngine()

◆ setConsecutiveHyphenLimit()

◆ setDefaultCharFeatures()

◆ setDefaultTabWidth()

◆ setDesiredGlyphScaling()

◆ setDesiredLetterSpacing()

◆ setDesiredWordSpacing()

◆ setEndIndent()

◆ setEveryLineComposer()

◆ setFirstLineIndent()

◆ setHyphenateCapitalized()

◆ setHyphenatedWordSize()

◆ setHyphenationPreference()

◆ setHyphenationZone()