All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces 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:
- CATIDrwText, CATIDrwTextProperties
Method Index
- o
GetListOfVariables(CATListValCATBaseUnknown_var*&)
- Get list of linked objects.
- o
GetParameter(CATDrwTextProperty&,int&,int&)
- Get parameter on the current text selection.
- o
GetParameter(CATDrwTextProperty&,double&,int&)
- Get parameter on the current text selection.
- o
GetParameter(CATDrwTextProperty&,CATUnicodeString&,int&)
- Get parameter on the current text selection.
- 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
GetVariablePositions(CATBaseUnknown_var&,CATListOfInt&)
- Get position list of linked objects.
- o
InsertSymbol(CATUnicodeString&,CATUnicodeString&)
-
- o
InsertVariable(CATBaseUnknown_var&,CATUnicodeString&)
- Insert a text semantic link.
- o
ResetSelection()
- Reset the selection to whole text.
- o
SetParameter(CATDrwTextProperty&,double&)
- Set parameter on the current text selection.
- o
SetParameter(CATDrwTextProperty&,CATUnicodeString&)
- Set parameter on the current text selection.
- o
SetParameter(CATDrwTextProperty&,int&)
- Set parameter on the current text selection.
- 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 GetListOfVariables
| public virtual GetListOfVariables( | | oList) |
-
Get list of linked objects.
- Parameters:
-
- oList
- Linked objects list.
o GetParameter
| public virtual GetParameter( | const | iParam, |
| | oValue, |
| | oPure) |
-
Get parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- oValue
- Integer value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same on whole sub-string.
Equals 0 if parameter value is not the same on whole sub-string.
o GetParameter
| public virtual GetParameter( | const | iParam, |
| | oValue, |
| | oPure) |
-
Get parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- oValue
- Double value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same on whole sub-string.
Equals 0 if parameter value is not the same on whole sub-string.
o GetParameter
| public virtual GetParameter( | const | iParam, |
| | oValue, |
| | oPure) |
-
Get parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- oValue
- String value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same on whole sub-string.
Equals 0 if parameter value is not the same on whole sub-string.
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 GetVariablePositions
| public virtual GetVariablePositions( | | iObject, |
| | oList) |
-
Get position list of linked objects.
- Parameters:
-
- iObject
- Linked object
- oList
- List of position where object is referenced.
o InsertSymbol
| public virtual InsertSymbol( | const | iSymbol, |
| const | iFont | ="") |
-
- Deprecated:
- V5R17 use CATIDrwSubString#SetSymbol
Insert a symbol in the current selection.
This symbol will remain displayed even if font is changed on the current selection.
- Parameters:
-
- iSymbol
- Unicode symbol value.
- iFont
- Font name to use for this symbol.
If no font is given a default one is taken according to the current standard and the
unicode value.
o InsertVariable
| public virtual InsertVariable( | | iObject, |
| const | iString | = "") |
-
Insert a text semantic link.
- Parameters:
-
- iObject
- Object from which value will be extracted.
- iAttName
- Attribute name to extract value.
o ResetSelection
| public virtual ResetSelection( | ) |
-
Reset the selection to whole text.
o SetParameter
| public virtual SetParameter( | const | iParam, |
| const | iValue) |
-
Set parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- iValue
- Double value.
o SetParameter
| public virtual SetParameter( | const | iParam, |
| const | iValue) |
-
Set parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- iValue
- String value.
o SetParameter
| public virtual SetParameter( | const | iParam, |
| const | iValue) |
-
Set parameter on the current text selection.
- Parameters:
-
- iParam
- Parameter type.
- See also:
- CATIDrwTextProperties
- iValue
- Integer value.
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.
CATIDrwSubString.ResetSelection
- 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: CATDraftingInterfaces