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

#include <ITextAttrProviderHyphStyle.h>

Inheritance diagram for ITextAttrProviderHyphStyle:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTATTRPROVIDERHYPHSTYLE }
 
typedef
IHyphenationStyle::ProviderHyphenationStyle 
ValueType
 

Public Member Functions

void Set (ValueType phs)
 
ValueType Get () const
 
virtual void SetProviderHyphStyle (ValueType providerHyphStyle)=0
 
virtual ValueType GetProviderHyphStyle () 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

ITextAttrProviderHyphStyle is a simple data interface that is used to hold the desired provider hyphenation style mode which influences the hyphenation points for the same provider: IHyphenationStyle::kHyph_All, IHyphenationStyle::kHyph_AllButUnaesthetic, IHyphenationStyle::kHyph_Aesthetic, IHyphenationStyle::kHyph_PreferredAesthetic.

Member Function Documentation

ValueType ITextAttrProviderHyphStyle::Get (void ) const
inline

Get the value

Returns
the provider hyphenation style
virtual ValueType ITextAttrProviderHyphStyle::GetProviderHyphStyle () const
pure virtual

Get the value

Returns
the provider hyphenation style
void ITextAttrProviderHyphStyle::Set (ValueType phs)
inline

Set the value

Parameters
phsspecifies the provider hyphenation style
virtual void ITextAttrProviderHyphStyle::SetProviderHyphStyle (ValueType providerHyphStyle)
pure virtual

Set the value

Parameters
providerHyphStylespecifies the provider hyphenation style