ITextAttrHyphenMode Class Reference

#include <ITextAttrHyphenMode.h>

Inheritance diagram for ITextAttrHyphenMode:

Public Types
enum	{ kDefaultIID = IID_ITEXTATTRHYPHENMODE }
typedef IHyphenationStyle::HyphenationMethod	ValueType

Public Member Functions
void	Set (ValueType flag)
ValueType	Get () const
virtual void	SetMethod (IHyphenationStyle::HyphenationMethod method)=0
virtual IHyphenationStyle::HyphenationMethod	GetMethod () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

ITextAttrHyphenMode is a simple data interface that is used to hold the desired hyphenation mode: on or off. Although the data supports off, manual, dictionary and algorithm, InDesign only directly provides access to "manual" and "algorithm" These correspond to "off" (hard & discretionary hyphens only) and "on" (everything including algorithmic hyphenation).

See Also

IHyphenationStyle

Member Function Documentation

ValueType ITextAttrHyphenMode::Get ( void  ) const

inline

Get the value.

Returns

the hyphenation mode.

virtual IHyphenationStyle::HyphenationMethod ITextAttrHyphenMode::GetMethod ( ) const

pure virtual

Get the value.

Returns

the hyphenation mode.

void ITextAttrHyphenMode::Set ( ValueType  flag )

inline

Set the value.

Parameters

flag	specifies the hyphenation mode.

virtual void ITextAttrHyphenMode::SetMethod ( IHyphenationStyle::HyphenationMethod  method )

pure virtual

Set the value.

Parameters

method

specifies the hyphenation mode.