Adobe.com
Contents Suites Classes Class Index Member Index

ATE::IParaInspector Class Reference

This class allows you to retrieve the paragraph features that apply to a specific paragraph, after considering all inherited style values and local overrides. More...

#include <IText.h>

List of all members.

Public Member Functions

 IParaInspector ()
 Constructor.
 IParaInspector (const IParaInspector &src)
 Copy constructor.
IParaInspectoroperator= (const IParaInspector &rhs)
 Assignment operator.
bool operator== (const IParaInspector &rhs) const
 Comparison operator tests for equality.
bool operator!= (const IParaInspector &rhs) const
 Comparison operator tests for inequality.
 IParaInspector (ParaInspectorRef parainspector)
 Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual ~IParaInspector ()
 Destructor.
ParaInspectorRef GetRef () const
 Retrieves a reference to this object.
bool IsNull () const
 Reports whether this is a null object.
IArrayParagraphJustification GetJustification () const
 Retrieves the justification values from the paragraph set.
IArrayReal GetFirstLineIndent () const
 Retrieves the first-line indent values from the paragraph set.
IArrayReal GetStartIndent () const
 Retrieves the start indent values from the paragraph set.
IArrayReal GetEndIndent () const
 Retrieves the end indent values from the paragraph set.
IArrayReal GetSpaceBefore () const
 Retrieves the line space before values from the paragraph set.
IArrayReal GetSpaceAfter () const
 Retrieves the line space after values from the paragraph set.
IArrayBool GetAutoHyphenate () const
 Retrieves the automatic hyphenation values from the paragraph set.
IArrayInteger GetHyphenatedWordSize () const
 Retrieves the hyphenated word size values from the paragraph set.
IArrayInteger GetPreHyphenSize () const
 Retrieves the pre-hyphen size values from the paragraph set.
IArrayInteger GetPostHyphenSize () const
 Retrieves the post-hyphen size values from the paragraph set.
IArrayInteger GetConsecutiveHyphenLimit () const
 Retrieves the consecutive hyphen limit values from the paragraph set.
IArrayReal GetHyphenationZone () const
 Retrieves the hyphenation zone values from the paragraph set.
IArrayBool GetHyphenateCapitalized () const
 Retrieves the hyphenate capitalized values from the paragraph set.
IArrayReal GetHyphenationPreference () const
 Retrieves the hyphenation preference values from the paragraph set.
IArrayReal GetDesiredWordSpacing () const
 Retrieves the desired word spacing values from the paragraph set.
IArrayReal GetMaxWordSpacing () const
 Retrieves the maximum word spacing values from the paragraph set.
IArrayReal GetMinWordSpacing () const
 Retrieves the minimum word spacing values from the paragraph set.
IArrayReal GetDesiredLetterSpacing () const
 Retrieves the desired letter spacing values from the paragraph set.
IArrayReal GetMaxLetterSpacing () const
 Retrieves the maximum letter spacing values from the paragraph set.
IArrayReal GetMinLetterSpacing () const
 Retrieves the minimum letter spacing values from the paragraph set.
IArrayReal GetDesiredGlyphScaling () const
 Retrieves the desired glyph scaling values from the paragraph set.
IArrayReal GetMaxGlyphScaling () const
 Retrieves the maximum glyph scaling values from the paragraph set.
IArrayReal GetMinGlyphScaling () const
 Retrieves the minimum glyph scaling values from the paragraph set.
IArrayParagraphJustification GetSingleWordJustification () const
 Retrieves the single-word justification values from the paragraph set.
IArrayReal GetAutoLeadingPercentage () const
 Retrieves the automatic leading percentage values from the paragraph set.
IArrayLeadingType GetLeadingType () const
 Retrieves the leading type values from the paragraph set.
IArrayTabStopsRef GetTabStops () const
 Retrieves the tab stops values from the paragraph set.
IArrayReal GetDefaultTabWidth () const
 Retrieves the tab width values from the paragraph set.
IArrayBool GetHangingRoman () const
 Retrieves the Japanese hanging Roman values from the paragraph set.
IArrayInteger GetAutoTCY () const
 Retrieves the automatic Tate Chu Yoko values from the paragraph set.
IArrayBool GetBunriKinshi () const
 Retrieves the Bunri Kinshi values from the paragraph set.
IArrayBurasagariType GetBurasagariType () const
 Retrieves the Burasagari type values from the paragraph set.
IArrayPreferredKinsokuOrder GetPreferredKinsokuOrder () const
 Retrieves the preferred Kinsoku order values from the paragraph set.
IArrayBool GetKurikaeshiMojiShori () const
 Retrieves the Kurikaeshi Moji Shori values from the paragraph set.
IArrayKinsokuRef GetKinsoku () const
 Retrieves the Kinsoku values from the paragraph set.
IArrayMojiKumiRef GetMojiKumi () const
 Retrieves the Moji Kumi values from the paragraph set.
IArrayBool GetEveryLineComposer () const
 Retrieves the every-line composer values from the paragraph set.
IArrayParagraphDirection GetParagraphDirection () const
 Retrieves the main writing direction values from the paragraph set.
IArrayJustificationMethod GetJustificationMethod () const
 Retrieves the justification method values from the paragraph set.
IArrayKashidaWidth GetKashidaWidth () const
 Retrieves the Kashida Width values from the paragraph set.
IArrayComposerEngine GetComposerEngine () const
 Retrieves the composer engine values from the paragraph set.

Detailed Description

This class allows you to retrieve the paragraph features that apply to a specific paragraph, after considering all inherited style values and local overrides.

Obtain an IParaInspector object from a text range or set of text ranges. See ITextRange::GetParaInspector().

The methods collect the values of a particular attribute into an array whose order is the same as the order of paragraphs in the text.


Constructor & Destructor Documentation

ATE::IParaInspector::IParaInspector (  ) 

Constructor.

Returns:
The new object.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

ATE::IParaInspector::IParaInspector ( const IParaInspector src  ) 

Copy constructor.

Parameters:
src The object to copy.
Returns:
The new object.

References ATE::sParaInspector.

ATE::IParaInspector::IParaInspector ( ParaInspectorRef  parainspector  )  [explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:
parainspector The C object.
Returns:
The new C++ object.
ATE::IParaInspector::~IParaInspector (  )  [virtual]

Destructor.

References ATE::sParaInspector.


Member Function Documentation

IArrayBool ATE::IParaInspector::GetAutoHyphenate (  )  const

Retrieves the automatic hyphenation values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetAutoLeadingPercentage (  )  const

Retrieves the automatic leading percentage values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayInteger ATE::IParaInspector::GetAutoTCY (  )  const

Retrieves the automatic Tate Chu Yoko values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBool ATE::IParaInspector::GetBunriKinshi (  )  const

Retrieves the Bunri Kinshi values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBurasagariType ATE::IParaInspector::GetBurasagariType (  )  const

Retrieves the Burasagari type values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayComposerEngine ATE::IParaInspector::GetComposerEngine (  )  const

Retrieves the composer engine values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayInteger ATE::IParaInspector::GetConsecutiveHyphenLimit (  )  const

Retrieves the consecutive hyphen limit values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetDefaultTabWidth (  )  const

Retrieves the tab width values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetDesiredGlyphScaling (  )  const

Retrieves the desired glyph scaling values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetDesiredLetterSpacing (  )  const

Retrieves the desired letter spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetDesiredWordSpacing (  )  const

Retrieves the desired word spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetEndIndent (  )  const

Retrieves the end indent values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBool ATE::IParaInspector::GetEveryLineComposer (  )  const

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

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetFirstLineIndent (  )  const

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

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBool ATE::IParaInspector::GetHangingRoman (  )  const

Retrieves the Japanese hanging Roman values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBool ATE::IParaInspector::GetHyphenateCapitalized (  )  const

Retrieves the hyphenate capitalized values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayInteger ATE::IParaInspector::GetHyphenatedWordSize (  )  const

Retrieves the hyphenated word size values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetHyphenationPreference (  )  const

Retrieves the hyphenation preference values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetHyphenationZone (  )  const

Retrieves the hyphenation zone values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayParagraphJustification ATE::IParaInspector::GetJustification (  )  const

Retrieves the justification values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayJustificationMethod ATE::IParaInspector::GetJustificationMethod (  )  const

Retrieves the justification method values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayKashidaWidth ATE::IParaInspector::GetKashidaWidth (  )  const

Retrieves the Kashida Width values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayKinsokuRef ATE::IParaInspector::GetKinsoku (  )  const

Retrieves the Kinsoku values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayBool ATE::IParaInspector::GetKurikaeshiMojiShori (  )  const

Retrieves the Kurikaeshi Moji Shori values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayLeadingType ATE::IParaInspector::GetLeadingType (  )  const

Retrieves the leading type values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMaxGlyphScaling (  )  const

Retrieves the maximum glyph scaling values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMaxLetterSpacing (  )  const

Retrieves the maximum letter spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMaxWordSpacing (  )  const

Retrieves the maximum word spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMinGlyphScaling (  )  const

Retrieves the minimum glyph scaling values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMinLetterSpacing (  )  const

Retrieves the minimum letter spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetMinWordSpacing (  )  const

Retrieves the minimum word spacing values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayMojiKumiRef ATE::IParaInspector::GetMojiKumi (  )  const

Retrieves the Moji Kumi values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayParagraphDirection ATE::IParaInspector::GetParagraphDirection (  )  const

Retrieves the main writing direction values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayInteger ATE::IParaInspector::GetPostHyphenSize (  )  const

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

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayPreferredKinsokuOrder ATE::IParaInspector::GetPreferredKinsokuOrder (  )  const

Retrieves the preferred Kinsoku order values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayInteger ATE::IParaInspector::GetPreHyphenSize (  )  const

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

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

ParaInspectorRef ATE::IParaInspector::GetRef (  )  const

Retrieves a reference to this object.

Returns:
The object reference.
IArrayParagraphJustification ATE::IParaInspector::GetSingleWordJustification (  )  const

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

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetSpaceAfter (  )  const

Retrieves the line space after values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetSpaceBefore (  )  const

Retrieves the line space before values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayReal ATE::IParaInspector::GetStartIndent (  )  const

Retrieves the start indent values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

IArrayTabStopsRef ATE::IParaInspector::GetTabStops (  )  const

Retrieves the tab stops values from the paragraph set.

Returns:
The array object containing the values.

References ATE::sParaInspector, and ATE::Throw_ATE_Exception().

bool ATE::IParaInspector::IsNull (  )  const

Reports whether this is a null object.

Returns:
True if this is a null object.

References ATE::sParaInspector.

bool ATE::IParaInspector::operator!= ( const IParaInspector rhs  )  const

Comparison operator tests for inequality.

Parameters:
rhs The object to compare to this one.
Returns:
True if the two objects are not the same.
IParaInspector & ATE::IParaInspector::operator= ( const IParaInspector rhs  ) 

Assignment operator.

Parameters:
rhs The object to assign to this one.
Returns:
A reference to this object.

References ATE::sParaInspector.

bool ATE::IParaInspector::operator== ( const IParaInspector rhs  )  const

Comparison operator tests for equality.

Parameters:
rhs The object to compare to this one.
Returns:
True if the two objects are the same.

The documentation for this class was generated from the following files:


Contents Suites Classes Class Index Member Index
Adobe Solutions Network
 
Copyright © 2016 Adobe Systems Incorporated. All rights reserved.
Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks