CATAnnotationUseItf Interface CATIDftText

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftText

Manage texts by selection in this text.

Method Index

o GetLinkTemplatesAssociatedTypes(CATListOfCATUnicodeString&)
o GetString(CATUnicodeString&): Get the text of the current selection.
o GetSubSet(wchar_t*,IID,IUnknown**): Returns an interface on a subset of the text.
o GetTextWidth(double*): Read the text Wrapping width.
o GetWrappingMode(DftWrappingMode*): Read the text Wrapping Mode.
o SetString(CATUnicodeString&): Modify the current selection with a new string.
o SetTextWidth(double): Set the Wrapping Width.
o SetWrappingMode(DftWrappingMode): Set or Unset the Wrapping Mode.
o SolveLinkTemplates(CATListValCATBaseUnknown_var)

Methods

o GetLinkTemplatesAssociatedTypes

public virtual GetLinkTemplatesAssociatedTypes( oAssociatedTypes)

o GetString

public virtual GetString( oText)

Get the text of the current selection.

Parameters:

oText: The returned text

o GetSubSet

public virtual GetSubSet(	const	`iSubSetName`,
	const	`iItfName`,
		`oSubSet`)

Returns an interface on a subset of the text.

Parameters:

iSubSetName: Can be for Texts :
"Global","Text","Selection","Leaders","WholeFrame"
iItfName: The interface id
oSubSet: The pointer on the asked interface. Can be NULL if the adhesion doesn't exists.

o GetTextWidth

public virtual GetTextWidth( oWidth)

Read the text Wrapping width.

Parameters:

oWidth: Wrapping width

Returns:

HRESULT S_OK : Operation is successful. E_FAIL or E_NOIMPL : the text cannot be wrapped.

o GetWrappingMode

public virtual GetWrappingMode( oMode)

Read the text Wrapping Mode.

Parameters:

oMode: Wrapping Mode

Returns:

HRESULT S_OK : Operation is successful. E_FAIL or E_NOIMPL : the text cannot be wrapped.

o SetString

public virtual SetString( const iText)

Modify the current selection with a new string.

Parameters:

iText: Text to insert/replace.
If the selection is a cursor, the text will be inserted.
If not the selection will be replaced.

o SetTextWidth

public virtual SetTextWidth( iWidth)

Set the Wrapping Width.

Parameters:

iWidth

Returns:

HRESULT S_OK : the text can be wrapped. E_FAIL or E_NOIMPL : the text cannot be wrapped.

o SetWrappingMode

public virtual SetWrappingMode( imode = DftWrappingAuto)

Set or Unset the Wrapping Mode.

Parameters:

imode: wrapping calculation mode = DftWrappingOn : set the wrapping width to iWidth = DftWrappingOff : unset the wrapping width = DftWrappingAuto : set the wrapping width to the longest text line (default)

Returns:

HRESULT S_OK : the text can be wrapped. E_FAIL or E_NOIMPL : the text cannot be wrapped.

o SolveLinkTemplates

public virtual SolveLinkTemplates( iAttributesOwners)

This object is included in the file: CATIDftText.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf