RTextBasedData

Class in Entity Module
Header: #include <src/core/RTextBasedData.h>
Inherits: REntityData, RPainterPathSource
Inherited by: RAttributeData, RAttributeDefinitionData, RTextData

Description

Stores and manages all data that defines the geometry and appearance of a text based entity (text, block attribute, block attribute definition).

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Copyable: Objects are cleaned up automatically by the garbage collector of the script engine.

Public Types

enum	TextFlag { NoFlags, Bold, Italic, Simple, DimensionLabel, Highlighted, Backward, UpsideDown }

Public Functions

	RTextBasedData(const RVector &position, const RVector &alignmentPoint, double textHeight, double textWidth, RS::VAlign verticalAlignment, RS::HAlign horizontalAlignment, RS::TextDrawingDirection drawingDirection, RS::TextLineSpacingStyle lineSpacingStyle, double lineSpacingFactor, const QString &text, const QString &fontName, bool bold, bool italic, double angle, bool simple)
	RTextBasedData(RDocument *document=NULL)
virtual	~RTextBasedData()
virtual bool	flipHorizontal()
virtual bool	flipVertical()
RVector	getAlignmentPoint() const
double	getAngle() const
virtual RBox	getBoundingBox(bool ignoreEmpty=false) const
virtual QList< RVector >	getCenterPoints(const RBox &queryBox=RDEFAULT_RBOX) const
virtual RVector	getClosestPointOnEntity(const RVector &point, double range, bool limited) const
virtual QSharedPointer< RShape >	getClosestShape(const RVector &pos, double range=RNANDOUBLE, bool ignoreComplex=false) const
virtual double	getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
RS::TextDrawingDirection	getDrawingDirection() const
virtual QList< RVector >	getEndPoints(const RBox &queryBox=RDEFAULT_RBOX) const
virtual QString	getEscapedText(bool escapeUnicode=false) const
virtual QList< QSharedPointer< RShape > >	getExploded() const
bool	getFlag(RTextBasedData::TextFlag flag) const
QString	getFontFile() const
QString	getFontName() const
RS::HAlign	getHAlign() const
double	getHeight() const Height of the text (this is not equal to the bounding box height as it is the height of the text at 0 angle).
double	getLineSpacingFactor() const
RS::TextLineSpacingStyle	getLineSpacingStyle() const
virtual QFont	getMainFont() const
virtual QList< RVector >	getMiddlePoints(const RBox &queryBox=RDEFAULT_RBOX) const
virtual QList< RPainterPath >	getPainterPaths(bool draft=false, double pixelSizeHint=RDEFAULT_MIN1) const
virtual QString	getPlainText() const
virtual RVector	getPointOnEntity() const
virtual QList< RVector >	getPointsWithDistanceToEnd(double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
RVector	getPosition() const
virtual QList< RRefPoint >	getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const
virtual QString	getRenderedText(bool escapeUnicode=false) const
QList< RVector >	getRotatedBoundingBox() const
virtual QList< QSharedPointer< RShape > >	getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const
QList< RTextBasedData >	getSimpleTextBlocks()
virtual QString	getText() const
double	getTextHeight() const
QList< RTextLayout >	getTextLayouts() const
double	getTextWidth() const Width of the text box used for line wrapping.
virtual RS::EntityType	getType() const
RS::VAlign	getVAlign() const
double	getWidth() const Width of the text (this is not equal to the bounding box width as it is the width of the text at 0 angle).
double	getXScale() const
virtual bool	intersectsWith(const RShape &shape) const
bool	isBackward() const
bool	isBold() const
bool	isDimensionLabel() const
virtual bool	isDirty() const
bool	isHighlighted() const
bool	isItalic() const
virtual bool	isSane() const
bool	isSimple() const
bool	isUpsideDown() const
virtual bool	isValid() const
virtual bool	mirror(const RLine &axis)
virtual bool	move(const RVector &offset) Moves this entity by the given offset.
virtual bool	moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier) Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.
virtual bool	rotate(double rotation, const RVector &center)
virtual bool	scale(const RVector &scaleFactors, const RVector &center)
void	setAlignmentPoint(const RVector &alignmentPoint)
void	setAngle(double angle)
void	setBackward(bool on)
void	setBold(bool on)
void	setDimensionLabel(bool on)
void	setDrawingDirection(RS::TextDrawingDirection drawingDirection)
void	setFlag(RTextBasedData::TextFlag flag, bool on=true)
void	setFontFile(const QString &fontFile)
void	setFontName(const QString &fontName)
void	setHAlign(RS::HAlign halign)
void	setHighlighted(bool on)
void	setItalic(bool on)
void	setLineSpacingFactor(double lineSpacingFactor)
void	setLineSpacingStyle(RS::TextLineSpacingStyle lineSpacingStyle)
void	setPosition(const RVector &position)
virtual void	setSelected(bool on) Selects or deselects this entity.
void	setSimple(bool on)
void	setText(const QString &text)
void	setTextHeight(double h)
void	setTextWidth(double w)
void	setUpsideDown(bool on)
void	setVAlign(RS::VAlign valign)
void	setXScale(double xScale)
void	sync(const RTextBasedData &other)
virtual void	to2D()
virtual void	update() const Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
virtual void	update(bool layout) const

Static Public Functions

static QString	escapeUnicode(const QString &str)
static RS::EntityType	getRtti()
static RTextProxy *	getTextProxy()
static bool	hasProxy()
static void	setTextProxy(RTextProxy *p)
static QString	toEscapedText(const QTextDocument &textDocument, const RColor &initialColor, double fontHeightFactor=1.0, bool simpleText=false) Converts the given text document (typically from a QTextEdit) into CAD escaped text.
static QString	toRichText(const QString &escapedText, const QFont &mainFont, double fontHeightFactor=1.0)

Protected Functions

	RTextBasedData(RDocument *document, const RTextBasedData &data)

Protected Attributes

RVector	alignmentPoint
double	angle
RBox	boundingBox
bool	dirty
RS::TextDrawingDirection	drawingDirection
TextFlags	flags
QString	fontFile
QString	fontName
bool	gotDraft
double	height
RS::HAlign	horizontalAlignment
double	lineSpacingFactor
RS::TextLineSpacingStyle	lineSpacingStyle
QList< RPainterPath >	painterPaths
RVector	position
QString	text
double	textHeight
QList< RTextLayout >	textLayouts
double	textWidth
RS::VAlign	verticalAlignment
double	width
double	xScale

Static Private Attributes

static RTextProxy *	textProxy

Friends

class	RTextBasedEntity

Member Documentation

TextFlag

enum TextFlag

Value	Description
NoFlags = 0x000
Bold = 0x001
Italic = 0x002
Simple = 0x004
DimensionLabel = 0x008
Highlighted = 0x010
Backward = 0x020
UpsideDown = 0x040

RTextBasedData

RTextBasedData::RTextBasedData(const RVector &position, const RVector &alignmentPoint, double textHeight, double textWidth, RS::VAlign verticalAlignment, RS::HAlign horizontalAlignment, RS::TextDrawingDirection drawingDirection, RS::TextLineSpacingStyle lineSpacingStyle, double lineSpacingFactor, const QString &text, const QString &fontName, bool bold, bool italic, double angle, bool simple)

Parameters:

• position: Insertion point (see DXF code 10 doc).
• alignmentPoint: Alignment point of text (see DXF code 11 doc).
• height: Nominal (initial) text height
• textWidth: Reference rectangle width for wrapping (not supported)
• valign: Vertical alignment
• halign: Horizontal alignment
• drawingDirection: Drawing direction
• lineSpacingStyle: Line spacing style
• lineSpacingFactor: Line spacing factor
• text: Text string
• fontName: Text font name
• angle: Rotation angle in rad

RTextBasedData

RTextBasedData::RTextBasedData(RDocument *document=NULL)

~RTextBasedData

virtual RTextBasedData::~RTextBasedData()

virtual inline

flipHorizontal

virtual bool RTextBasedData::flipHorizontal()

virtual

Reimplemented from flipHorizontal.

flipVertical

virtual bool RTextBasedData::flipVertical()

virtual

Reimplemented from flipVertical.

getAlignmentPoint

RVector RTextBasedData::getAlignmentPoint() const

inline const

Returns: Alignment point of the reference point of the text. This is usually the same as the position.

getAngle

double RTextBasedData::getAngle() const

inline const

getBoundingBox

virtual RBox RTextBasedData::getBoundingBox(bool ignoreEmpty=false) const

virtual const

Returns: The bounding box that contains this entity.

Reimplemented from getBoundingBox.

getCenterPoints

virtual QList< RVector > RTextBasedData::getCenterPoints(const RBox &queryBox=RDEFAULT_RBOX) const

virtual inline const

getClosestPointOnEntity

virtual RVector RTextBasedData::getClosestPointOnEntity(const RVector &point, double range, bool limited) const

virtual const

getClosestShape

virtual QSharedPointer< RShape > RTextBasedData::getClosestShape(const RVector &pos, double range=RNANDOUBLE, bool ignoreComplex=false) const

virtual inline const

getDistanceTo

virtual double RTextBasedData::getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const

virtual const

Returns: The shortest distance from this entity to the given point.

Parameters:

• limited: Limit lines, arcs at end points, otherwise the orthogonal distance to the unlimited line / circle is returned.
• range: This is returned for solid filled entities (solid filled or dense hatches, text entities) if the point is on the entity and the distance would be zero.
• draft: Calculate based on draft mode representation of the entity.
• strictRange: If limited, this is the maximum range from either end point of the entity. Zero to only return distances that are strictly orthogonal to the entity.

Reimplemented from getDistanceTo.

getDrawingDirection

RS::TextDrawingDirection RTextBasedData::getDrawingDirection() const

inline const

getEndPoints

virtual QList< RVector > RTextBasedData::getEndPoints(const RBox &queryBox=RDEFAULT_RBOX) const

virtual inline const

getEscapedText

virtual QString RTextBasedData::getEscapedText(bool escapeUnicode=false) const

virtual const

getExploded

virtual QList< QSharedPointer< RShape > > RTextBasedData::getExploded() const

virtual const

getFlag

bool RTextBasedData::getFlag(RTextBasedData::TextFlag flag) const

inline const

getFontFile

QString RTextBasedData::getFontFile() const

inline const

getFontName

QString RTextBasedData::getFontName() const

inline const

getHAlign

RS::HAlign RTextBasedData::getHAlign() const

inline const

getHeight

double RTextBasedData::getHeight() const

const

Height of the text (this is not equal to the bounding box height as it is the height of the text at 0 angle).

getLineSpacingFactor

double RTextBasedData::getLineSpacingFactor() const

inline const

getLineSpacingStyle

RS::TextLineSpacingStyle RTextBasedData::getLineSpacingStyle() const

inline const

getMainFont

virtual QFont RTextBasedData::getMainFont() const

virtual const

getMiddlePoints

virtual QList< RVector > RTextBasedData::getMiddlePoints(const RBox &queryBox=RDEFAULT_RBOX) const

virtual inline const

getPainterPaths

virtual QList< RPainterPath > RTextBasedData::getPainterPaths(bool draft=false, double pixelSizeHint=RDEFAULT_MIN1) const

virtual const

Reimplemented from getPainterPaths.

getPlainText

virtual QString RTextBasedData::getPlainText() const

virtual const

getPointOnEntity

virtual RVector RTextBasedData::getPointOnEntity() const

virtual const

Returns: A point that is on the entity. Used to check if an entity is inside a polygon.

Reimplemented from getPointOnEntity.

getPointsWithDistanceToEnd

virtual QList< RVector > RTextBasedData::getPointsWithDistanceToEnd(double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const

virtual inline const

getPosition

RVector RTextBasedData::getPosition() const

inline const

Returns: Position of the reference point of the text.

getReferencePoints

virtual QList< RRefPoint > RTextBasedData::getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const

virtual const

Returns: Vector of reference points of this entity. Reference points can usually be moved around by the user to change the geometry of the entity.

Reimplemented from getReferencePoints.

Reimplemented in getReferencePoints.

getRenderedText

virtual QString RTextBasedData::getRenderedText(bool escapeUnicode=false) const

virtual const

Reimplemented in getRenderedText, getRenderedText.

getRotatedBoundingBox

QList< RVector > RTextBasedData::getRotatedBoundingBox() const

const

getShapes

virtual QList< QSharedPointer< RShape > > RTextBasedData::getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const

virtual const

Returns: Shapes that represent the geometry of this entity.

Parameters:

• queryBox: Limit returned shapes to query box
• ignoreComplex: Ignore complex shapes and explode those into simple shapes
• segment: Split up splines into spline segments

Reimplemented from getShapes.

getSimpleTextBlocks

QList< RTextBasedData > RTextBasedData::getSimpleTextBlocks()

Returns: List of text data objects representing simple texts. Complex formatted texts are split up into smaller text blocks, each with unique formatting, color, etc.

getText

virtual QString RTextBasedData::getText() const

virtual inline const

getTextHeight

double RTextBasedData::getTextHeight() const

inline const

getTextLayouts

QList< RTextLayout > RTextBasedData::getTextLayouts() const

const

getTextWidth

double RTextBasedData::getTextWidth() const

inline const

Width of the text box used for line wrapping.

getType

virtual RS::EntityType RTextBasedData::getType() const

virtual inline const

Reimplemented from getType.

Reimplemented in getType, getType, getType.

getVAlign

RS::VAlign RTextBasedData::getVAlign() const

inline const

getWidth

double RTextBasedData::getWidth() const

const

Width of the text (this is not equal to the bounding box width as it is the width of the text at 0 angle).

getXScale

double RTextBasedData::getXScale() const

inline const

intersectsWith

virtual bool RTextBasedData::intersectsWith(const RShape &shape) const

virtual const

Returns: True if this entity intersects with the given shape, false otherwise.

Reimplemented from intersectsWith.

isBackward

bool RTextBasedData::isBackward() const

inline const

isBold

bool RTextBasedData::isBold() const

inline const

isDimensionLabel

bool RTextBasedData::isDimensionLabel() const

inline const

isDirty

virtual bool RTextBasedData::isDirty() const

virtual const

isHighlighted

bool RTextBasedData::isHighlighted() const

inline const

isItalic

bool RTextBasedData::isItalic() const

inline const

isSane

virtual bool RTextBasedData::isSane() const

virtual const

Reimplemented from isSane.

isSimple

bool RTextBasedData::isSimple() const

inline const

isUpsideDown

bool RTextBasedData::isUpsideDown() const

inline const

isValid

virtual bool RTextBasedData::isValid() const

virtual inline const

Reimplemented from isValid.

mirror

virtual bool RTextBasedData::mirror(const RLine &axis)

virtual

Reimplemented from mirror.

move

virtual bool RTextBasedData::move(const RVector &offset)

virtual

Moves this entity by the given offset.

Reimplemented from move.

moveReferencePoint

virtual bool RTextBasedData::moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier)

virtual

Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.

Returns: True if a reference point has been moved successfully, false otherwise.

Reimplemented from moveReferencePoint.

rotate

virtual bool RTextBasedData::rotate(double rotation, const RVector &center)

virtual

Reimplemented from rotate.

scale

virtual bool RTextBasedData::scale(const RVector &scaleFactors, const RVector &center)

virtual

Reimplemented from scale.

setAlignmentPoint

void RTextBasedData::setAlignmentPoint(const RVector &alignmentPoint)

inline

setAngle

void RTextBasedData::setAngle(double angle)

inline

setBackward

void RTextBasedData::setBackward(bool on)

inline

setBold

void RTextBasedData::setBold(bool on)

inline

setDimensionLabel

void RTextBasedData::setDimensionLabel(bool on)

inline

setDrawingDirection

void RTextBasedData::setDrawingDirection(RS::TextDrawingDirection drawingDirection)

inline

setFlag

void RTextBasedData::setFlag(RTextBasedData::TextFlag flag, bool on=true)

inline

setFontFile

void RTextBasedData::setFontFile(const QString &fontFile)

inline

setFontName

void RTextBasedData::setFontName(const QString &fontName)

setHAlign

void RTextBasedData::setHAlign(RS::HAlign halign)

inline

setHighlighted

void RTextBasedData::setHighlighted(bool on)

inline

setItalic

void RTextBasedData::setItalic(bool on)

inline

setLineSpacingFactor

void RTextBasedData::setLineSpacingFactor(double lineSpacingFactor)

inline

setLineSpacingStyle

void RTextBasedData::setLineSpacingStyle(RS::TextLineSpacingStyle lineSpacingStyle)

inline

setPosition

void RTextBasedData::setPosition(const RVector &position)

inline

setSelected

virtual void RTextBasedData::setSelected(bool on)

virtual inline

Selects or deselects this entity.

Reimplemented from setSelected.

setSimple

void RTextBasedData::setSimple(bool on)

inline

setText

void RTextBasedData::setText(const QString &text)

setTextHeight

void RTextBasedData::setTextHeight(double h)

inline

setTextWidth

void RTextBasedData::setTextWidth(double w)

inline

setUpsideDown

void RTextBasedData::setUpsideDown(bool on)

inline

setVAlign

void RTextBasedData::setVAlign(RS::VAlign valign)

inline

setXScale

void RTextBasedData::setXScale(double xScale)

inline

sync

void RTextBasedData::sync(const RTextBasedData &other)

to2D

virtual void RTextBasedData::to2D()

virtual

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

Reimplemented from to2D.

update

virtual void RTextBasedData::update() const

virtual inline const

Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).

Reimplemented from update.

update

virtual void RTextBasedData::update(bool layout) const

virtual const

escapeUnicode

static QString RTextBasedData::escapeUnicode(const QString &str)

static

getRtti

static RS::EntityType RTextBasedData::getRtti()

static inline

getTextProxy

static RTextProxy * RTextBasedData::getTextProxy()

static inline

Non-Scriptable: This function is not available in script environments.

hasProxy

static bool RTextBasedData::hasProxy()

static inline

setTextProxy

static void RTextBasedData::setTextProxy(RTextProxy *p)

static inline

Non-Scriptable: This function is not available in script environments.

toEscapedText

static QString RTextBasedData::toEscapedText(const QTextDocument &textDocument, const RColor &initialColor, double fontHeightFactor=1.0, bool simpleText=false)

static

Converts the given text document (typically from a QTextEdit) into CAD escaped text.

Parameters:

• fontHeightFactor: factor applied to all font heights. This allows the text edit to use a bigger / smaller font that needed in the end.

toRichText

static QString RTextBasedData::toRichText(const QString &escapedText, const QFont &mainFont, double fontHeightFactor=1.0)

static

Returns: HTML representing this text.

RTextBasedData

RTextBasedData::RTextBasedData(RDocument *document, const RTextBasedData &data)

protected

alignmentPoint

RVector RTextBasedData::alignmentPoint

protected

angle

double RTextBasedData::angle

protected

boundingBox

RBox RTextBasedData::boundingBox

protected

dirty

bool RTextBasedData::dirty

protected

drawingDirection

RS::TextDrawingDirection RTextBasedData::drawingDirection

protected

flags

TextFlags RTextBasedData::flags

protected

fontFile

QString RTextBasedData::fontFile

protected

fontName

QString RTextBasedData::fontName

protected

gotDraft

bool RTextBasedData::gotDraft

protected

height

double RTextBasedData::height

protected

horizontalAlignment

RS::HAlign RTextBasedData::horizontalAlignment

protected

lineSpacingFactor

double RTextBasedData::lineSpacingFactor

protected

lineSpacingStyle

RS::TextLineSpacingStyle RTextBasedData::lineSpacingStyle

protected

painterPaths

QList<RPainterPath> RTextBasedData::painterPaths

protected

position

RVector RTextBasedData::position

protected

text

QString RTextBasedData::text

protected

textHeight

double RTextBasedData::textHeight

protected

textLayouts

QList<RTextLayout> RTextBasedData::textLayouts

protected

textWidth

double RTextBasedData::textWidth

protected

verticalAlignment

RS::VAlign RTextBasedData::verticalAlignment

protected

width

double RTextBasedData::width

protected

xScale

double RTextBasedData::xScale

protected

textProxy

static RTextProxy * RTextBasedData::textProxy = NULL

static private

All rights reserved.

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

RTextBasedEntity

friend class RTextBasedEntity

private