All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface CATIDrwText
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwText
Interface to manage a text.
- See also:
- CATIDrwSubString, CATIDrwTextProperties
Method Index
- o
GetGlobalParameter(CATDrwTextSetting,int&)
- Read global parameter text integer values.
- o
GetGlobalParameter(CATDrwTextSetting,double&)
- Read global parameter text double values.
- o
GetListOfVariables(CATListValCATBaseUnknown_var*&)
- Get list of linked objects.
- o
GetParameterOnSubString(CATDrwTextProperty,int,int,int&,int&)
- Get text parameter integer values.
- o
GetParameterOnSubString(CATDrwTextProperty,int,int,double&,int&)
- Get text parameter double values.
- o
GetParameterOnSubString(CATDrwTextProperty,int,int,CATUnicodeString&,int&)
- Get text parameter string values.
- o
GetStringAt(CATUnicodeString&,int,int)
- Get the text string between to character indexes.
- o
GetVariablePositions(CATBaseUnknown*,CATListOfInt&)
- Get positions in list of linked objects.
- o
GetWrappingWidth(double&)
- Read the text wrapping width.
- o
InsertSymbol(CATUnicodeString,int,int,CATUnicodeString)
-
- o
InsertVariable(int,CATBaseUnknown*,CATUnicodeString&)
- Insert a text semantic link.
- o
IsWrapped(CATDrwWrappingMode&)
- Get the wrapping text mode.
- o
Isolate(CATBaseUnknown*)
- Isolate the text from its semantic link.
- o
SetGlobalParameter(CATDrwTextSetting,int)
- Set global parameter text integer values.
- o
SetGlobalParameter(CATDrwTextSetting,double)
- Set global parameter text double values.
- o
SetParameterOnSubString(CATDrwTextProperty,int,int,int)
- Set text parameter integer values.
- o
SetParameterOnSubString(CATDrwTextProperty,int,int,double)
- Set text parameter double values.
- o
SetParameterOnSubString(CATDrwTextProperty,int,int,CATUnicodeString)
- Set text parameter string values.
- o
SetStringAt(CATUnicodeString,int,int)
- Manage the text string.
- o
SetWrappingWidth(CATDrwWrappingMode,double)
- Set or unset the wrapping width.
Methods
o GetGlobalParameter
| public virtual GetGlobalParameter( | | iParam, |
| | oValue) |
-
Read global parameter text integer values.
- Parameters:
-
- iParam
- Parameter type.
- oValue
- Parameter output value.
- See also:
- CATDrwTextSetting
o GetGlobalParameter
| public virtual GetGlobalParameter( | | iParam, |
| | oValue) |
-
Read global parameter text double values.
- Parameters:
-
- iParam
- Parameter type.
- oValue
- Parameter output value.
- See also:
- CATDrwTextSetting
o GetListOfVariables
| public virtual GetListOfVariables( | | oList) |
-
Get list of linked objects.
- Parameters:
-
- oList
- [out, delete] [out] Linked objects list.
o GetParameterOnSubString
| public virtual GetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | oValue, |
| | oPure) |
-
Get text parameter integer values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to get.
- iEnd
- Last character to get
- oValue
- Parameter output value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
- See also:
- CATDrwTextProperty
o GetParameterOnSubString
| public virtual GetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | oValue, |
| | oPure) |
-
Get text parameter double values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to get.
- iEnd
- Last character to get
- oValue
- Parameter output value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
- See also:
- CATDrwTextProperty
o GetParameterOnSubString
| public virtual GetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | oValue, |
| | oPure) |
-
Get text parameter string values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to get.
- iEnd
- Last character to get
- oValue
- Parameter output value.
- oPure
- Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
- See also:
- CATDrwTextProperty
o GetStringAt
| public virtual GetStringAt( | | oString, |
| | iStart | =0, |
| | iEnd | =0) |
-
Get the text string between to character indexes.
- Parameters:
-
- iStart
- First character to get.
If iStart equals 0 string is got from the begining.
- iEnd
- Last character to get.
If iEnd equals 0 string is got to the end.
- oString
- Output string.
o GetVariablePositions
| public virtual GetVariablePositions( | | ipObject, |
| | oList) |
-
Get positions in list of linked objects.
- Parameters:
-
- ipObject
- Linked object.
- oList
- List of positions where link is referenced.
o GetWrappingWidth
| public virtual GetWrappingWidth( | | oWidth) |
-
Read the text wrapping width.
- Parameters:
-
- oWidth
- Wrapping width value.
o InsertSymbol
| public virtual InsertSymbol( | | iSymbol, |
| | iStart, |
| | iEnd, |
| | iFont | ="") |
-
- Deprecated:
- V5R17 use CATIDrwSubString#SetSymbol
Insert a symbol in a text.
This symbol will remain displayed even if text font is changed.
- Parameters:
-
- iSymbol
- Unicode symbol value.
- iStart
- Start location .
- iEnd
- End location
- 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( | | iPos, |
| | ipObject, |
| const | iAttName | ="") |
-
Insert a text semantic link.
- Parameters:
-
- iPos
- Character insertion position.
- ipObject
- Object from which value will be extracted or Type of object to link with.
- iAttName
- Attribute name to extract value.
o IsWrapped
| public virtual IsWrapped( | | oMode) |
-
Get the wrapping text mode.
- Parameters:
-
- oMode
- Wrapping text mode.
Refer to CATDrwUtility.
o Isolate
| public virtual Isolate( | | ipObject | =NULL) |
-
Isolate the text from its semantic link.
- Parameters:
-
- ipObject
- Object to isolate the text from.
If no object is given the text will be isolated from all its links.
o SetGlobalParameter
| public virtual SetGlobalParameter( | | iParam, |
| | iValue) |
-
Set global parameter text integer values.
- Parameters:
-
- iParam
- Parameter type.
- iValue
- Parameter input value.
- See also:
- CATDrwTextSetting
o SetGlobalParameter
| public virtual SetGlobalParameter( | | iParam, |
| | iValue) |
-
Set global parameter text double values.
- Parameters:
-
- iParam
- Parameter type.
- iValue
- Parameter input value.
- See also:
- CATDrwTextSetting
o SetParameterOnSubString
| public virtual SetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | iValue) |
-
Set text parameter integer values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to modify.
- iEnd
- Last character to modify.
- iValue
- Parameter input value.
- See also:
- CATDrwTextProperty
o SetParameterOnSubString
| public virtual SetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | iValue) |
-
Set text parameter double values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to modify.
- iEnd
- Last character to modify.
- iValue
- Parameter input value.
- See also:
- CATDrwTextProperty
o SetParameterOnSubString
| public virtual SetParameterOnSubString( | | iParam, |
| | iStart, |
| | iEnd, |
| | iValue) |
-
Set text parameter string values.
- Parameters:
-
- iParam
- Parameter type.
- iStart
- First character to modify.
- iEnd
- Last character to modify.
- iValue
- Parameter input value.
- See also:
- CATDrwTextProperty
o SetStringAt
| public virtual SetStringAt( | | iString, |
| | iStart | =0, |
| | iEnd | =0) |
-
Manage the text string.
- Parameters:
-
- iString
- String to add to the text.
- iStart
- First character to modify.
- iEnd
- Last character to modify.
Parameters combinations :
If iStart and iEnd equal 0 iString is appended to the text.
If iStart equals 0 and iEnd is greater than 0 all text is replaced by iString.
If iStart greater than 0 and iEnd equals 0 iString is inserted at iStart character.
If iStart and iEnd are greater than 0 characters between iStart and iEnd
will be replaced iString.
o SetWrappingWidth
| public virtual SetWrappingWidth( | | imode | =CATDrwWrappingAuto, |
| | iWidth | =0.) |
-
Set or unset the wrapping width.
- Parameters:
-
- iMode
- wrapping text mode.
Refer to CATDrwUtility.
- iWidth
- Wrapping Width value.
This object is included in the file: CATIDrwText.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces