#include <DbMText.h>
Static Public Member Functions | |
| static const OdString | nonBreakSpace () |
| static const OdString | overlineOn () |
| static const OdString | overlineOff () |
| static const OdString | underlineOn () |
| static const OdString | underlineOff () |
| static const OdString | colorChange () |
| static const OdString | fontChange () |
| static const OdString | heightChange () |
| static const OdString | widthChange () |
| static const OdString | obliqueChange () |
| static const OdString | trackChange () |
| static const OdString | lineBreak () |
| static const OdString | paragraphBreak () |
| static const OdString | stackStart () |
| static const OdString | alignChange () |
| static const OdString | blockBegin () |
| static const OdString | blockEnd () |
| static const OdString | strikethroughOn () |
| static const OdString | strikethroughOff () |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
<group OdDb_Classes>
This class represents paragraph (multi-line) text (MText) entities in an OdDbDatabase instance.
Corresponding C++ library: TD_Db
- See also
- <link db_text_multi.html, Working with Multi-Line Text>
Member Enumeration Documentation
◆ AttachmentPoint
◆ ColumnType
◆ FlowDirection
Constructor & Destructor Documentation
◆ OdDbMText()
| OdDbMText::OdDbMText | ( | ) |
Member Function Documentation
◆ actualHeight()
| double OdDbMText::actualHeight | ( | OdGiWorldDraw * | ctxt = 0 | ) | const |
Returns the actual height of this MText entity (depends on contents).
- Parameters
-
ctxt [in] Drawing context.
- Remarks
- If ctxt is null, the current OdGiWorldDraw object will be used.
◆ actualWidth()
| double OdDbMText::actualWidth | ( | ) | const |
Returns the width of the bounding box of this MText entity.
- Remarks
- This value will probably be different than that returned by OdDbMText::width().
◆ alignChange()
|
static |
Returns the alignment change string "\A".
- Remarks
- May be used in place of "\A" to make code more understandable.
◆ ascent()
| double OdDbMText::ascent | ( | ) | const |
Returns the ascent of this MText entity.
◆ attachment()
| AttachmentPoint OdDbMText::attachment | ( | ) | const |
Returns the type of the attachment point of this MText entity (DXF 71).
- Remarks
- attachment() returns one of the following:
Value kTopLeft 1 kTopCenter 2 kTopRight 3 kMiddleLeft 4 kMiddleCenter 5 kMiddleRight 6 kBottomLeft 7 kBottomCenter 8 kBottomRight 9
◆ backgroundFillOn()
| bool OdDbMText::backgroundFillOn | ( | ) | const |
Returns true if and only if background fill is on of this MText entity (DXF 90, bit 0x01).
◆ blockBegin()
|
static |
Returns the begin block string "{".
- Remarks
- May be used in place of "{" to make code more understandable.
◆ blockEnd()
|
static |
Returns the end block string "}".
- Remarks
- May be used in place of "}" to make code more understandable.
◆ colorChange()
|
static |
Returns the color change string "\C".
- Remarks
- May be used in place of "\C" to make code more understandable.
◆ contents()
| OdString OdDbMText::contents | ( | ) | const |
Returns a copy of the character content of this MText entity (DXF 1 & 3).
◆ convertFieldToText()
| void OdDbMText::convertFieldToText | ( | ) |
Converts the fields in this MText entity to text, and removes the fields.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The fields are not evaluated before conversion.
◆ descent()
| double OdDbMText::descent | ( | ) | const |
Returns the descent of this MText entity.
◆ direction()
| OdGeVector3d OdDbMText::direction | ( | ) | const |
Returns the WCS X-axis direction vector of this MText entity (DXF 11).
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ explodeFragments()
| void OdDbMText::explodeFragments | ( | OdDbMTextEnum | fragmentFn, |
| void * | params, | ||
| OdGiWorldDraw * | ctxt = 0 |
||
| ) | const |
Explodes this MText entity into a sequence of simple text fragments, passing each fragment to the specified function
- Parameters
-
fragmentFn [in] Function pointer to the fragment elaboration callback function. params [in] Void pointer to the fragmentFn callback function's second argument. ctxt [in] Drawing context.
- Remarks
- The prototype of the fragment elaboration is as follows:
int (*OdDbMtextEnum)(OdDbMTextFragment *fragment, void *param)
If ctxt is null, the current OdGiWorldDraw object will be used.
The elaboration function should return 1 to continue, or 0 to terminate the explosion.
Each new line in this MText entity, and each change of text attributes, will start a new fragment.
◆ explodeGeometry()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Remarks
- The newly created entities will be not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbEntity.
◆ flowDirection()
| FlowDirection OdDbMText::flowDirection | ( | ) | const |
Returns the flow direction of this MText entity (DXF 72).
- Remarks
- flowDirection() returns one of the following:
Value kLtoR 1 kRtoL 2 kTtoB 3 kBtoT 4 kByStyle 5
◆ fontChange()
|
static |
Returns the font change string "\F".
- Remarks
- May be used in place of "\F" to make code more understandable.
◆ getActualBoundingPoints()
| void OdDbMText::getActualBoundingPoints | ( | OdGePoint3dArray & | boundingPoints, |
| double | dGapX = 0., |
||
| double | dGapY = 0. |
||
| ) | const |
Returns the WCS actual bounding points of this MText entity.
- Parameters
-
boundingPoints [out] Receives the bounding points. dGapX [in] specifies gap aroung actual text in X direction. dGapY [in] specifies gap aroung actual text in Y direction.
- Remarks
- The points are returned as follows:
Corner boundingPoints[0] Top left boundingPoints[1] Top right boundingPoints[2] Bottom left boundingPoints[3] Bottom right
◆ getBackgroundFillColor()
| OdCmColor OdDbMText::getBackgroundFillColor | ( | ) | const |
Returns the background fill color of this MText entity (DXF 63 and optionally 421 & 431).
◆ getBackgroundScaleFactor()
| double OdDbMText::getBackgroundScaleFactor | ( | ) | const |
Returns the background scale factor of this MText entity (DXF 45).
- Remarks
- The filled background area is extended by (ScaleFactor - 1) * TextHeight in all directions.
◆ getBackgroundTransparency()
| OdCmTransparency OdDbMText::getBackgroundTransparency | ( | ) | const |
Returns the background transparency of this MText entity (DXF 441).
◆ getBoundingPoints()
| void OdDbMText::getBoundingPoints | ( | OdGePoint3dArray & | boundingPoints | ) | const |
Returns the WCS bounding points of this MText entity box.
- Parameters
-
boundingPoints [out] Receives the bounding points.
- Remarks
- The points are returned as follows:
Corner boundingPoints[0] Top left boundingPoints[1] Top right boundingPoints[2] Bottom left boundingPoints[3] Bottom right
◆ getColumnAutoHeight()
| bool OdDbMText::getColumnAutoHeight | ( | ) | const |
Returns the column auto height status of this MText entity.
◆ getColumnCount()
| OdInt32 OdDbMText::getColumnCount | ( | ) | const |
Returns the column count of this MText entity.
◆ getColumnFlowReversed()
| bool OdDbMText::getColumnFlowReversed | ( | ) | const |
Returns the column flow reverse status of this MText entity.
◆ getColumnGutterWidth()
| double OdDbMText::getColumnGutterWidth | ( | ) | const |
Returns the column gutter of this MText entity.
◆ getColumnHeight()
| double OdDbMText::getColumnHeight | ( | OdInt16 | col | ) | const |
Returns the column height of this MText entity.
- Parameters
-
col [in] Column number.
◆ getColumnType()
| ColumnType OdDbMText::getColumnType | ( | ) | const |
Returns the column type of this MText entity.
- Remarks
- The type is returned as follows:
Value kNoColumns 1 kStaticColumns 2 kDynamicColumns 3
◆ getColumnWidth()
| double OdDbMText::getColumnWidth | ( | ) | const |
Returns the column width of this MText entity.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
Reimplemented from OdDbEntity.
◆ getParagraphsIndent()
| void OdDbMText::getParagraphsIndent | ( | OdDbMTextIndents & | indents | ) | const |
Returns the paragraph indentation and tab data of this MText entity.
- Parameters
-
indents [out] Receives the indentation and tab data.
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
planarity and plane return values as follows::
Value Description plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arrbitrary plane containing this entity
Reimplemented from OdDbEntity.
◆ height()
| double OdDbMText::height | ( | ) | const |
Returns the height of the box of this MText entity.
◆ heightChange()
|
static |
Returns the height change string "\H".
- Remarks
- May be used in place of "\H" to make code more understandable.
◆ horizontalMode()
| OdDb::TextHorzMode OdDbMText::horizontalMode | ( | ) | const |
Returns the horizontal mode of this MText entity (used for DXF 71).
- Remarks
- horizontalMode returns one of the following:
Value OdDb::kTextLeft 0 OdDb::kTextCenter 1 OdDb::kTextRight 2 OdDb::kTextAlign 3 OdDb::kTextMid 4 OdDb::kTextFit 5
◆ lineBreak()
|
static |
Returns the line break string "\p".
- Remarks
- May be used in place of "\p" to make code more understandable.
◆ lineSpacingFactor()
| double OdDbMText::lineSpacingFactor | ( | ) | const |
Returns the linespacing factor of this MText entity (DXF 44).
◆ lineSpacingStyle()
| OdDb::LineSpacingStyle OdDbMText::lineSpacingStyle | ( | ) | const |
Returns the linespacing style of this MText entity (DXF 73).
◆ location()
| OdGePoint3d OdDbMText::location | ( | ) | const |
Returns the insertion point of this MText entity (WCS equivalent of DXF 10).
◆ nonBreakSpace()
|
static |
Returns the non-break space string "\~".
- Remarks
- May be used in place of "\~" to make code more understandable.
◆ normal()
| OdGeVector3d OdDbMText::normal | ( | ) | const |
Returns the WCS normal to the plane of this entity (DXF 210).
◆ obliqueChange()
|
static |
Returns the oblique angle change string "\Q".
- Remarks
- May be used in place of "\Q" to make code more understandable.
◆ ODDB_DECLARE_MEMBERS()
| OdDbMText::ODDB_DECLARE_MEMBERS | ( | OdDbMText | ) |
◆ overlineOff()
|
static |
Returns the overline off string "\o".
- Remarks
- May be used in place of "\o" to make code more understandable.
◆ overlineOn()
|
static |
Returns the overline on string "\O".
- Remarks
- May be used in place of "\O" to make code more understandable.
◆ paragraphBreak()
|
static |
Returns the paragraph break string "\P".
- Remarks
- May be used in place of "\P" to make code more understandable.
◆ removeField() [1/2]
|
virtual |
Removes the specified field from the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the entry.
- Remarks
- Returns the Object ID of the removed field if successful, or a null Object ID if not.
Reimplemented from OdDbObject.
◆ removeField() [2/2]
|
virtual |
Removes the specified field from the field dictionary of this object.
- Parameters
-
fieldId [in] Object ID for the field.
- Remarks
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbObject.
◆ rotation()
| double OdDbMText::rotation | ( | ) | const |
Returns the rotation angle of this MText entity in radians (DXF 50).
◆ setAttachment()
| void OdDbMText::setAttachment | ( | AttachmentPoint | type | ) |
Sets the type of the attachment point of this MText entity (DXF 71).
- Parameters
-
type [in] Type of the attachment point.
- Remarks
- attachment must be one of the following:
Value kTopLeft 1 kTopCenter 2 kTopRight 3 kMiddleLeft 4 kMiddleCenter 5 kMiddleRight 6 kBottomLeft 7 kBottomCenter 8 kBottomRight 9
- Remarks
- setAttachment() keeps the location of this MText entity constant while changing the attachment type, thereby changing the extents of (moving) this MText entity.
setAttachmentMovingLocation() moves the location of the MText entity while changing the attachment type, thereby maintaining the extents (not moving) this MText entity.
Throws: Method generates the eInvalidInput exception when the text attachment number is out of the range 1 to 9.
- See also
- OdDbMText::setAttachmentMovingLocation() method
◆ setAttachmentMovingLocation()
| OdResult OdDbMText::setAttachmentMovingLocation | ( | AttachmentPoint | attachment | ) |
Sets the type of the attachment point of this MText entity (DXF 71).
- Parameters
-
attachment [in] Type of the attachment point.
- Remarks
- attachment must be one of the following:
Value kTopLeft 1 kTopCenter 2 kTopRight 3 kMiddleLeft 4 kMiddleCenter 5 kMiddleRight 6 kBottomLeft 7 kBottomCenter 8 kBottomRight 9
- Remarks
- setAttachment() keeps the location of this MText entity constant while changing the attachment type, thereby changing the extents of (moving) this MText entity.
setAttachmentMovingLocation() adjusts the location of the MText entity while changing the attachment type, so as to maintain the extents (not move) this MText entity.
- See also
- OdDbMText::setAttachment() method
◆ setBackgroundFill()
| void OdDbMText::setBackgroundFill | ( | bool | bEnable | ) |
Controls the background fill of this MText entity (DXF 90, bit 0x01).
- Parameters
-
bEnable [in] True to enable background fill, false to disable.
◆ setBackgroundFillColor()
Sets the background fill color of this MText entity (DXF 63 and optionally 421 & 431).
- Parameters
-
color [in] New color value.
◆ setBackgroundScaleFactor()
| void OdDbMText::setBackgroundScaleFactor | ( | const double | scaleFactor | ) |
Sets the background scale factor of this MText entity (DXF 45).
- Parameters
-
scaleFactor [in] Background scale factor. [1..5]
- Remarks
- The filled background area is extended by (ScaleFactor - 1) * TextHeight in all directions.
Throws: Method generates the eInvalidInput exception when the scale factor is out of the range 1.0 to 5.0.
◆ setBackgroundTransparency()
| void OdDbMText::setBackgroundTransparency | ( | const OdCmTransparency & | transparency | ) |
Sets the background transparency of this MText entity (DXF 441).
- Parameters
-
transparency [in] New transparency value.
◆ setColumnAutoHeight()
| void OdDbMText::setColumnAutoHeight | ( | bool | bAutoHeigh | ) |
Switches the column auto height status of this MText entity.
- Parameters
-
bAutoHeigh [in] New column auto height status.
Throws: Method generates the eNotApplicable exception when the column type is not set to kDynamicColumns.
◆ setColumnCount()
Sets the column count of this MText entity.
- Parameters
-
numCol [in] Number of columns.
Throws: Method generates the eInvalidInput exception when the column count is out of the range 1 to 100.
◆ setColumnFlowReversed()
| void OdDbMText::setColumnFlowReversed | ( | bool | bFlowRev | ) |
Switches the column flow reverse status of this MText entity.
- Parameters
-
bFlowRev [in] New status.
◆ setColumnGutterWidth()
| void OdDbMText::setColumnGutterWidth | ( | double | colGutter | ) |
Sets the column gutter of this MText entity.
- Parameters
-
colGutter [in] Gutter of columns.
Throws: Method generates the eInvalidInput exception when the column gutter is a negative value.
◆ setColumnHeight()
Sets the column height of this MText entity.
- Parameters
-
col [in] Column number. colHeight [in] Height of the specified column.
Throws: Method generates the eInvalidInput exception when the column height is a non-positive double value.
◆ setColumnType()
| void OdDbMText::setColumnType | ( | ColumnType | colType | ) |
Sets the column type of this MText entity.
- Parameters
-
colType [in] Column type.
Value kNoColumns 1 kStaticColumns 2 kDynamicColumns 3
◆ setColumnWidth()
| void OdDbMText::setColumnWidth | ( | double | colWidth | ) |
Sets the column width of this MText entity.
- Parameters
-
colWidth [in] Width of columns.
Throws: Method generates the eInvalidInput exception when the column width is a non-positive double value.
◆ setContents()
| int OdDbMText::setContents | ( | const OdString & | text | ) |
Sets the character content of this MText entity (DXF 1 & 3).
- Parameters
-
text [in] New character content.
◆ setContentsRTF()
| int OdDbMText::setContentsRTF | ( | const OdString & | text | ) |
Sets the character content of this MText entity (DXF 1 & 3) from the RTF-encoded text string.
- Parameters
-
text [in] New character content.
◆ setDirection()
| void OdDbMText::setDirection | ( | const OdGeVector3d & | direction | ) |
Sets the WCS X-axis direction vector of this MText entity (DXF 11).
- Parameters
-
direction [in] Direction vector.
- Remarks
- Direction and rotation are equivalent, and only one need be set when creating (or modifying) an MText entity.
◆ setDynamicColumns()
| void OdDbMText::setDynamicColumns | ( | double | width, |
| double | gutter, | ||
| bool | bAutoHeigh | ||
| ) |
◆ setField()
|
virtual |
Adds the specified field to the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the new entry. pField [in] Pointer to the field object.
- Returns
- Returns the Object ID of the new entry.
Reimplemented from OdDbObject.
◆ setFlowDirection()
| void OdDbMText::setFlowDirection | ( | FlowDirection | flowDirection | ) |
Sets the flow direction of this MText entity (DXF 72).
- Parameters
-
flowDirection [in] New flow direction enumerator.
- Remarks
- flowDirection() returns one of the following:
Value kLtoR 1 kRtoL 2 kTtoB 3 kBtoT 4 kByStyle 5
Throws: Method generates the eInvalidInput exception when the flow direction is out of the range 1 to 5.
◆ setHeight()
| void OdDbMText::setHeight | ( | double | value | ) |
Sets the height of the box of this MText entity.
- Parameters
-
value [in] New height value.
◆ setHorizontalMode()
| void OdDbMText::setHorizontalMode | ( | OdDb::TextHorzMode | horizontalMode | ) |
Sets the horizontal mode of this MText entity (used for DXF 71).
- Parameters
-
horizontalMode [in] Horizontal mode.
- Remarks
- horizontalMode must be one of the following:
Value OdDb::kTextLeft 0 OdDb::kTextCenter 1 OdDb::kTextRight 2 OdDb::kTextAlign 3 OdDb::kTextMid 4 OdDb::kTextFit 5
Throws: Method generates the eNotApplicable exception when the horizontal mode is out of the range 0 to 5.
◆ setLineSpacingFactor()
| void OdDbMText::setLineSpacingFactor | ( | double | lineSpacingFactor | ) |
Sets the linespacing factor of this MText entity (DXF 44).
- Parameters
-
lineSpacingFactor [in] Linespacing Factor.
Throws: Method generates the eInvalidInput exception when the line spacing factor is out of the range 0.25 to 4.00.
◆ setLineSpacingStyle()
| void OdDbMText::setLineSpacingStyle | ( | OdDb::LineSpacingStyle | lineSpacingStyle | ) |
Sets the linespacing style of this MText entity (DXF 73).
- Parameters
-
lineSpacingStyle [in] Linespacing style.
Value kAtLeast 1 kExactly 2
Throws: Method generates the eInvalidInput exception when the linespacing style is not 1 or 2.
◆ setLocation()
| void OdDbMText::setLocation | ( | const OdGePoint3d & | location | ) |
Sets the insertion point of this MText entity (WCS equivalent of DXF 10).
- Parameters
-
location [in] Insertion point.
◆ setNormal()
| void OdDbMText::setNormal | ( | const OdGeVector3d & | normal | ) |
Sets the WCS normal to the plane of this entity (DXF 210).
- Parameters
-
normal [in] Normal.
◆ setRotation()
| void OdDbMText::setRotation | ( | double | rotation | ) |
Sets the rotation angle of this MText entity in radians (DXF 50).
- Parameters
-
rotation [in] Rotation angle in radians.
◆ setShowBorders()
| void OdDbMText::setShowBorders | ( | bool | bEnable | ) |
Sets the flag controlling mtext border's visibility.
- Parameters
-
bEnable [in] - True means borders will be visible and false means borders will be invisible.
◆ setStaticColumns()
◆ setTextHeight()
| void OdDbMText::setTextHeight | ( | double | height | ) |
Sets the text height of this MText entity (DXF 40).
- Parameters
-
height [in] New text height value.
Throws: Method generates the eInvalidInput exception when the text height is less than or equal to zero.
◆ setTextStyle()
| void OdDbMText::setTextStyle | ( | OdDbObjectId | textStyleId | ) |
Sets the Object ID of the text style of this MText entity (DXF 7).
- Parameters
-
textStyleId [in] Text style Object ID.
◆ setUseBackgroundColor()
| void OdDbMText::setUseBackgroundColor | ( | bool | enable | ) |
Controls the use of the screen background color as the background color of this MText entity (DXF 90, bit 0x02).
- Parameters
-
enable [in] True to use the screen background color, false to use the setBackgroundFillColor() method.
◆ setVerticalMode()
| void OdDbMText::setVerticalMode | ( | OdDb::TextVertMode | verticalMode | ) |
Sets the vertical mode of this MText entity (used for DXF 71).
- Parameters
-
verticalMode [in] Vertical mode.
- Remarks
- verticalMode must be one of the following:
Value OdDb::kTextBottom 1 OdDb::kTextVertMid 2 OdDb::kTextTop 3
Throws: Method generates the eNotApplicable exception when the vertical mode is out of the range 1 to 3.
◆ setWidth()
| void OdDbMText::setWidth | ( | double | width | ) |
Sets the word-wrap width of this MText entity (DXF 41).
- Parameters
-
width [in] Word-wrap width
- Remarks
- Words exceeding this value will extend beyond the Specified width.
◆ showBorders()
| bool OdDbMText::showBorders | ( | ) |
Gets the flag controlling mtext border's visibility.
◆ stackStart()
|
static |
Returns the stacked text start string "\S".
- Remarks
- May be used in place of "\S" to make code more understandable.
◆ strikethroughOff()
|
static |
Returns the strike through off string "\k".
- Remarks
- May be used in place of "\k" to make code more understandable.
◆ strikethroughOn()
|
static |
Returns the strike through on string "\K".
- Remarks
- May be used in place of "\K" to make code more understandable.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the dimension style of this entity to the current style for the specified database.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ text()
| OdString OdDbMText::text | ( | ) |
Gets contents without formate codes.
◆ textHeight()
| double OdDbMText::textHeight | ( | ) | const |
Returns the text height of this MText entity (DXF 40).
◆ textStyle()
| OdDbObjectId OdDbMText::textStyle | ( | ) | const |
Returns the Object ID of the text style of this MText entity (DXF 7).
◆ trackChange()
|
static |
Returns the track change string "\T".
- Remarks
- May be used in place of "\T" to make code more understandable.
◆ underlineOff()
|
static |
Returns the underline off string "\l".
- Remarks
- May be used in place of "\l" to make code more understandable.
◆ underlineOn()
|
static |
Returns the underline on string "\L".
- Remarks
- May be used in place of "\L" to make code more understandable.
◆ useBackgroundColorOn()
| bool OdDbMText::useBackgroundColorOn | ( | ) | const |
Returns true if and only if the screen background color is used as the/ background color/ of this MText entity (DXF 90, bit 0x02).
◆ verticalMode()
| OdDb::TextVertMode OdDbMText::verticalMode | ( | ) | const |
Returns the vertical mode of this MText entity (used for DXF 71).
- Remarks
- verticalMode() returns one of the following:
Value OdDb::kTextBase 0 OdDb::kkTextBottom 1 OdDb::kkTextVertMid 2 OdDb::kkTextTop 3
◆ width()
| double OdDbMText::width | ( | ) | const |
Returns the word-wrap width of this MText entity (DXF 41).
- Remarks
- Words exceeding this value will extend beyond this width.
◆ widthChange()
|
static |
Returns the width change string "\W".
- Remarks
- May be used in place of "\W" to make code more understandable.
The documentation for this class was generated from the following file: