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

#include <IHyphExceptionsPrefs.h>

Inheritance diagram for IHyphExceptionsPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPHEXCEPTIONPREFS }
 
enum  HyphPrefType { kUserDictionaryOnly = 0, kDocumentOnly, kBoth }
 

Public Member Functions

virtual HyphPrefType GetHyphExceptionType (void) const =0
 
virtual void SetHyphExceptionType (HyphPrefType hyphPrefType)=0
 
virtual bool16 GetStoreInDocument (void) const =0
 
virtual void SetStoreInDocument (const bool16 inDoc)=0
 
virtual bool16 GetRecompose (void) const =0
 
virtual void SetRecompose (const bool16 recompose)=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

Hyphenation Exceptions Preferences interface.

Member Function Documentation

virtual HyphPrefType IHyphExceptionsPrefs::GetHyphExceptionType (void ) const
pure virtual

GetHyphExceptionType.

Returns
the preference for the user dictionary.
virtual bool16 IHyphExceptionsPrefs::GetRecompose (void ) const
pure virtual

GetRecompose.

Returns
the preference for recomposing when the user dictionary changes.
virtual bool16 IHyphExceptionsPrefs::GetStoreInDocument (void ) const
pure virtual

GetStoreInDocument.

Returns
whether the user dictionary is stored in the document.
virtual void IHyphExceptionsPrefs::SetHyphExceptionType (HyphPrefType hyphPrefType)
pure virtual

SetHyphExceptionType. Set the preference for the user dictionary.

Parameters
hyphPrefTypespecifies the preference for the user dictionary.
virtual void IHyphExceptionsPrefs::SetRecompose (const bool16 recompose)
pure virtual

SetRecompose. Set the preference for the user dictionary.

Parameters
recomposespecifies the preference for recomposing when the user dictionary changes.
virtual void IHyphExceptionsPrefs::SetStoreInDocument (const bool16 inDoc)
pure virtual

SetStoreInDocument. Set the preference for the user dictionary.

Parameters
inDocspecifies the preference for storing the user dictionary in the document.