ITextAreaPrefsData Class Reference

#include <ITextAreaPrefsData.h>

Inheritance diagram for ITextAreaPrefsData:

Public Types
enum	{ kDefaultIID = IID_ITEXTAREAPREFSDATA }

Public Member Functions
virtual void	Set (UIDRef docref, const PMReal width, const PMReal depth, const ITextAreaPrefs::TextAreaDepthUnit unitIndex)=0
virtual void	SetDocument (UIDRef docref)=0
virtual UIDRef	GetDocument () const =0
virtual void	SetTextAreaWidth (const PMReal width)=0
virtual PMReal	GetTextAreaWidth () const =0
virtual void	SetTextAreaDepth (const PMReal depth)=0
virtual PMReal	GetTextAreaDepth () const =0
virtual void	SetTextAreaDepthUnit (const ITextAreaPrefs::TextAreaDepthUnit unitIndex)=0
virtual ITextAreaPrefs::TextAreaDepthUnit	GetTextAreaDepthUnit () 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

This interface is used to cache data for creating document or document styles related commands including kInCopyNewDocCmdBoss, kDocEditPresetCmdBoss, kSaveDocumentPresetDataCmdBoss, kSetTextAreaPrefsCmdBoss

Member Enumeration Documentation

anonymous enum

Define the default IID for ITextAreaPrefsData.

Member Function Documentation

virtual UIDRef ITextAreaPrefsData::GetDocument ( ) const

pure virtual

Get the document UIDRef

Returns

UIDRef of document

virtual PMReal ITextAreaPrefsData::GetTextAreaDepth ( ) const

pure virtual

Get the depth of text area.

Returns

const the depth of the text area

virtual ITextAreaPrefs::TextAreaDepthUnit ITextAreaPrefsData::GetTextAreaDepthUnit ( ) const

pure virtual

Get the unit idnex of depth of text area.

Returns

const the unit index of depth of the text area

virtual PMReal ITextAreaPrefsData::GetTextAreaWidth ( ) const

pure virtual

Get the width of text area.

Returns

const the width of the text area

virtual void ITextAreaPrefsData::SetDocument ( UIDRef  docref )

pure virtual

SetDocument indicating the document to set the ITextAreaPrefs. not setting the document means to set the ITextAreaPrefs in session workspace

Parameters

docref

refers to the document to set the ITextAreaPrefs .

Returns

void.

virtual void ITextAreaPrefsData::SetTextAreaDepth ( const PMReal  depth )

pure virtual

Set the depth of text area.

Parameters

depth

the depth of the text area

Returns

void.

virtual void ITextAreaPrefsData::SetTextAreaDepthUnit ( const ITextAreaPrefs::TextAreaDepthUnit  unitIndex )

pure virtual

Set the unit index for the depth of text area.

Parameters

unitIndex

the index of unit for the depth of the text area

Returns

void.

virtual void ITextAreaPrefsData::SetTextAreaWidth ( const PMReal  width )

pure virtual

Set the width of text area.

Parameters

width

the width of the text area

Returns

void.