SnpHyphenation Class Reference

Public Member Functions
	SnpHyphenation ()
virtual	~SnpHyphenation ()
ErrorCode	ReportHyphenationPolicy (ITextAttributeSuite *iTextAttributeSuite)
ErrorCode	ModifyHyphenationPolicy (ITextAttributeSuite *iTextAttributeSuite)

Detailed Description

Sample code snippet that shows how access the hyphenation policy that applies to text, and how to set the hyphenation policy for particular text.

Constructor & Destructor Documentation

SnpHyphenation::SnpHyphenation ( )

inline

Constructor.

virtual SnpHyphenation::~SnpHyphenation ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpHyphenation::ModifyHyphenationPolicy

(

ITextAttributeSuite *

iTextAttributeSuite

)

Adapts from the UI to model.

Parameters

iTextAttributeSuite

IN the attribute suite used to manipulate the attributes. This means any updates are based on the context of the call. If we call with a text selection, it is the attributes that apply that are modified. If there is no text selection, it will be the document of session preferences that are modified.

Returns

kFailure on error or if the user cancels

ErrorCode SnpHyphenation::ReportHyphenationPolicy

(

ITextAttributeSuite *

iTextAttributeSuite

)

Adapts from the UI to model.

Parameters

iTextAttributeSuite

IN the suite used to get the value of the attributes. If there is a text selection, we wil get the value of the attributes that apply to the text, otherwise we will retrieve the document or session defaults.

Returns

kFailure on error or if the user cancels