InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDrawingStyleME Class Referenceabstract

#include <IDrawingStyleME.h>

Inheritance diagram for IDrawingStyleME:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDRAWINGSTYLEME }
 

Public Member Functions

virtual void SetDigits (IDigitsAttr::Digits digits)=0
 
virtual IDigitsAttr::Digits GetDigits () const =0
 
virtual void SetKashida (int32 kashida)=0
 
virtual int32 GetKashida () const =0
 
virtual void SetDirOverride (IDirOverrideAttr::DirOverride dir)=0
 
virtual
IDirOverrideAttr::DirOverride 
GetDirOverride () const =0
 
virtual PMReal GetNarrowHardSpaceWidth (bool16 vertical) const =0
 
virtual void SetDiacVPos (int32 vpos)=0
 
virtual int32 GetDiacVPos () const =0
 
virtual void SetDiacXOffset (PMReal r)=0
 
virtual PMReal GetDiacXOffset () const =0
 
virtual void SetDiacYOffset (PMReal r)=0
 
virtual PMReal GetDiacYOffset () const =0
 
virtual void SetBaseFontMissing (bool16 b)=0
 
virtual bool16 IsBaseFontMissing () const =0
 
virtual void SetKeyboardDir (IDirOverrideAttr::DirOverride dir)=0
 
virtual
IDirOverrideAttr::DirOverride 
GetKeyboardDir () const =0
 
virtual
IDirOverrideAttr::DirOverride 
GetEffectiveCharDir () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

IDrawingStyleME is the primary interface of character attribute ME summary data. Text attributes can be summarized into a kComposeStyleBoss object, which is a non-persistent summary of every text attribute applied to some text. IDrawingStyleME lists most, but not all character attributes specific to the world ready composer: kashida preference, digit preference, etc. IDrawingStyleME should be considered a "read-only" interface because the set operations have no impact beyond this data interface. It does not apply through to the text that this interface derived from. The text attributes themselves are the primary setters of the data.

See Also
IDrawingStyle

Member Function Documentation

virtual int32 IDrawingStyleME::GetDiacVPos () const
pure virtual
Get the diacritic vertical position preference.

Returns
the diacritic's vertical position preference.
See Also
IDiacVPosAttr.
virtual PMReal IDrawingStyleME::GetDiacXOffset () const
pure virtual
Get the diacritic x position offset from the default location.

Returns
the x-offset for diacritics.
virtual PMReal IDrawingStyleME::GetDiacYOffset () const
pure virtual
Get the diacritic y position offset from the default location.

Returns
the y-offset for diacritics.
virtual IDigitsAttr::Digits IDrawingStyleME::GetDigits () const
pure virtual
Get the digits used by the world ready composer.

Returns
the digit type.
See Also
IDigitsAttr.
virtual IDirOverrideAttr::DirOverride IDrawingStyleME::GetDirOverride () const
pure virtual
Get the character direction override for the world ready composer.

Returns
the direction override.
See Also
IDirOverrideAttr.
virtual IDirOverrideAttr::DirOverride IDrawingStyleME::GetEffectiveCharDir () const
pure virtual
GetEffectiveCharDir consolidates the paragraph direction

with the character direction override.

Returns
the character's direction.
virtual int32 IDrawingStyleME::GetKashida () const
pure virtual
Get the kashida preference for the world ready composer.

Returns
the kashida preference.
See Also
IKashidaAttr.
virtual IDirOverrideAttr::DirOverride IDrawingStyleME::GetKeyboardDir () const
pure virtual
Get the keyboard direction (right-to-left or left-to-right).

Returns
the direction of the keyboard.
See Also
IDirOverrideAttr.
virtual PMReal IDrawingStyleME::GetNarrowHardSpaceWidth (bool16 vertical) const
pure virtual
GetNarrowHardSpaceWidth is used to override the space width for Farsi.

Returns
the width of the non-breaking space.
virtual bool16 IDrawingStyleME::IsBaseFontMissing () const
pure virtual

the composer sets this when the base font of a complementary font is missing in the world ready composer. Should not be set otherwise.

virtual void IDrawingStyleME::SetBaseFontMissing (bool16 b)
pure virtual

the composer sets this when the base font of a complementary font is missing in the world ready composer. Should not be set otherwise.

virtual void IDrawingStyleME::SetDiacVPos (int32 vpos)
pure virtual
Set the diacritic vertical position preference.

Parameters
vposis the diacritic's vertical position preference.
See Also
IDiacVPosAttr.
virtual void IDrawingStyleME::SetDiacXOffset (PMReal r)
pure virtual
Set the diacritic x position offset from the default location.

Parameters
ris the x-offset for diacritics.
virtual void IDrawingStyleME::SetDiacYOffset (PMReal r)
pure virtual
Set the diacritic y position offset from the default location.

Parameters
rthe y-offset for diacritics.
virtual void IDrawingStyleME::SetDigits (IDigitsAttr::Digits digits)
pure virtual
Set the digits used by the world ready composer.

Parameters
valis the digit type.
See Also
IDigitsAttr.
virtual void IDrawingStyleME::SetDirOverride (IDirOverrideAttr::DirOverride dir)
pure virtual
Set the character direction override for the world ready composer.

Parameters
diris the direction override.
See Also
IDirOverrideAttr.
virtual void IDrawingStyleME::SetKashida (int32 kashida)
pure virtual
Set the kashida preference for the world ready composer.

Parameters
kashidais the kashida preference.
See Also
IKashidaAttr.
virtual void IDrawingStyleME::SetKeyboardDir (IDirOverrideAttr::DirOverride dir)
pure virtual
Set the keyboard direction (right-to-left or left-to-right).

Parameters
diris the direction of the keyboard.
See Also
IDirOverrideAttr.