Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDrwSubString

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

interface CATIDrwSubString

Interface to manage a text sub-string.

See also:: ,

Method Index

o GetSelection(int&,int&,int&): Get the current selection on a text.
o GetString(CATUnicodeString&): Get the string of the current selection.
o GetSymbol(CATUnicodeString&): Get a symbol in the current selection.
o ResetSelection(): Reset the selection to whole text.
o SetAttributeLink(CATBaseUnknown*,CATUnicodeString&): Creates an associative Link between the text and an attribute of an object.
o SetParameterLink(CATBaseUnknown*): Creates an associative Link between the text and a parameter.
o SetSelection(int&,int&,int&): Set the current selection on a text.
o SetString(CATUnicodeString&): Set the string of the current selection.
o SetSymbol(CATUnicodeString&): Get a symbol in the current selection.

Methods

o GetSelection

public virtual GetSelection(		`oFirst`,
		`oLast`,
	const	`iMode`	`=0`)

Get the current selection on a text.

Parameters:

oFirst: First selected character.
oLast: Last selected character.
If oFirst and oLast equal zero, whole text is selected.
iMode: Cursor selection mode : define how iFirst and iLast parameters must be valuated.
If mode equals 0 character position starts form 1 (1 is before first character)
If mode equals 1 character position starts form 0 (0 is before first character)
Examples :
On the ABCD string
If iFirst and iLast equal zero, whole text will be selected.

o GetString

public virtual GetString( oString)

Get the string of the current selection.

Parameters:

iString: String of the current selection.

o GetSymbol

public virtual GetSymbol( oSymbol)

Get a symbol in the current selection.

Parameters:

oSymbol: symbol name as defined in standard

o ResetSelection

public virtual ResetSelection(

)

Reset the selection to whole text.

o SetAttributeLink

public virtual SetAttributeLink(		`ipObj`,
	const	`iAttrName`)

Creates an associative Link between the text and an attribute of an object.
Role: Replaces the currently selected subpart of the text with the value of an attribute, with associativity to attribute modifications.

Parameters:

ipObj: [in] The object on which attribute value is to reflect the value in the text string.

iAttrName

[in] The name of the attribute to reflect the value in the text string.

Returns:

S_OK if everything ran ok, and the Attribute Link has been added E_UNEXPECTED if an error occurs (see preconditions...)

o SetParameterLink

public virtual SetParameterLink( ipParm)

Creates an associative Link between the text and a parameter.
Role: Replaces the currently selected subpart of the text with the value of a parameter, with associativity to parameter modifications.

Parameters:

ipParm: [in] The parameter to reflect the value in the text string.

Returns:

S_OK if everything ran ok, and the Parameter Link has been added E_UNEXPECTED if an error occurs (see preconditions...)

o SetSelection

public virtual SetSelection(	const	`iFirst`,
	const	`iLast`,
	const	`iMode`	`=0`)

Set the current selection on a text.
When a selection is set, it has to be reset once texts edition is finished.

Parameters:

iFirst: First character to select.
iLast: Last character to select.
iMode: Cursor selection mode : define how iFirst and iLast parameters must be valuated.
If mode equals 0 character position starts form 1 (1 is before first character)
If mode equals 1 character position starts form 0 (0 is before first character)
Examples :
On the ABCD string
If iFirst and iLast equal zero, whole text will be selected.

o SetString

public virtual SetString( const iString)

Set the string of the current selection.

Parameters:

iString: String to set at the current selection.

o SetSymbol

public virtual SetSymbol( const iSymbol)

Get a symbol in the current selection.

Parameters:

iSymbol: symbol name as defined in standard

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