RTextBasedEntity

Class in Entity Module
Header: #include <src/core/RTextBasedEntity.h>
Inherits: REntity
Inherited by: RAttributeDefinitionEntity, RAttributeEntity, RTextEntity

Description

Text entity.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

	RTextBasedEntity(RDocument *document)
virtual	~RTextBasedEntity()
virtual void	exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const Exports the entity to the given exporter.
RVector	getAlignmentPoint() const
double	getAngle() const
virtual const RTextBasedData &	getData() const =0 = 0
virtual RTextBasedData &	getData()=0 = 0
RS::TextDrawingDirection	getDrawingDirection() const
QString	getEscapedText(bool escapeUnicode=false) const
virtual QList< QSharedPointer< RShape > >	getExploded() const
QString	getFontFile() const
QString	getFontName() const
RS::HAlign	getHAlign() const
double	getHeight() const
double	getLineSpacingFactor() const
RS::TextLineSpacingStyle	getLineSpacingStyle() const
QList< RPainterPath >	getPainterPaths(bool draft=false) const
QString	getPlainText() const
RVector	getPosition() const
virtual QPair< QVariant, RPropertyAttributes >	getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
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 RTextBasedData &	getTextData()
double	getTextHeight() const
double	getTextWidth() const
RS::VAlign	getVAlign() const
double	getWidth() const
double	getXScale() const
bool	isBackward() const
bool	isBold() const
bool	isItalic() const
bool	isSimple() const
bool	isUpsideDown() const
virtual QSharedPointer< REntity >	scaleNonUniform(const RVector &scaleFactors, const RVector &center)
void	setAlignmentPoint(const RVector &alignmentPoint)
void	setAngle(double angle)
void	setBackward(bool on)
void	setBold(bool on)
void	setDrawingDirection(RS::TextDrawingDirection drawingDirection)
void	setFontName(const QString &fontName)
void	setHAlign(RS::HAlign ha)
void	setItalic(bool on)
void	setLineSpacingFactor(double lineSpacingFactor)
void	setLineSpacingStyle(RS::TextLineSpacingStyle lineSpacingStyle)
void	setPosition(const RVector &position)
virtual bool	setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL) Sets the given property to the given value.
void	setSimple(bool on)
void	setText(const QString &text)
void	setTextHeight(double h)
void	setUpsideDown(bool on)
void	setVAlign(RS::VAlign va)
void	setXScale(double xScale)
void	sync(const RTextBasedEntity &other)

Static Public Functions

static QSet< RPropertyTypeId >	getStaticPropertyTypeIds()
static void	init()

Static Public Attributes

static RPropertyTypeId	PropertyAngle
static RPropertyTypeId	PropertyBackward
static RPropertyTypeId	PropertyBlock
static RPropertyTypeId	PropertyBold
static RPropertyTypeId	PropertyColor
static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyDisplayedColor
static RPropertyTypeId	PropertyDrawOrder
static RPropertyTypeId	PropertyFontName
static RPropertyTypeId	PropertyHAlign
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyHeight
static RPropertyTypeId	PropertyItalic
static RPropertyTypeId	PropertyLayer
static RPropertyTypeId	PropertyLineSpacingFactor
static RPropertyTypeId	PropertyLinetype
static RPropertyTypeId	PropertyLinetypeScale
static RPropertyTypeId	PropertyLineweight
static RPropertyTypeId	PropertyPlainText
static RPropertyTypeId	PropertyPositionX
static RPropertyTypeId	PropertyPositionY
static RPropertyTypeId	PropertyPositionZ
static RPropertyTypeId	PropertySimple
static RPropertyTypeId	PropertyText
static RPropertyTypeId	PropertyType
static RPropertyTypeId	PropertyUpsideDown
static RPropertyTypeId	PropertyVAlign
static RPropertyTypeId	PropertyWidth
static RPropertyTypeId	PropertyXScale

Protected Functions

virtual void	print(QDebug dbg) const Stream operator for QDebug.

Member Documentation

RTextBasedEntity

RTextBasedEntity::RTextBasedEntity(RDocument *document)

~RTextBasedEntity

virtual RTextBasedEntity::~RTextBasedEntity()

virtual

exportEntity

virtual void RTextBasedEntity::exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const

virtual const

Exports the entity to the given exporter.

The exporter might be a file exporter, a graphics scene or any other platform one can export entities to.

Reimplemented from exportEntity.

Reimplemented in exportEntity.

getAlignmentPoint

RVector RTextBasedEntity::getAlignmentPoint() const

inline const

getAngle

double RTextBasedEntity::getAngle() const

inline const

getData

virtual const RTextBasedData & RTextBasedEntity::getData() const =0 = 0

pure virtual const

Returns: Const reference to the data object of the entity.

Reimplemented from getData.

Reimplemented in getData, getData, getData.

getData

virtual RTextBasedData & RTextBasedEntity::getData()=0 = 0

pure virtual

Returns: Reference to the data object of the entity.

Reimplemented from getData.

Reimplemented in getData, getData, getData.

getDrawingDirection

RS::TextDrawingDirection RTextBasedEntity::getDrawingDirection() const

inline const

getEscapedText

QString RTextBasedEntity::getEscapedText(bool escapeUnicode=false) const

inline const

getExploded

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

virtual inline const

getFontFile

QString RTextBasedEntity::getFontFile() const

inline const

getFontName

QString RTextBasedEntity::getFontName() const

inline const

getHAlign

RS::HAlign RTextBasedEntity::getHAlign() const

inline const

getHeight

double RTextBasedEntity::getHeight() const

inline const

getLineSpacingFactor

double RTextBasedEntity::getLineSpacingFactor() const

inline const

getLineSpacingStyle

RS::TextLineSpacingStyle RTextBasedEntity::getLineSpacingStyle() const

inline const

getPainterPaths

QList< RPainterPath > RTextBasedEntity::getPainterPaths(bool draft=false) const

inline const

getPlainText

QString RTextBasedEntity::getPlainText() const

inline const

getPosition

RVector RTextBasedEntity::getPosition() const

inline const

getProperty

virtual QPair< QVariant, RPropertyAttributes > RTextBasedEntity::getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)

virtual

Returns: The value and attributes of the given property or an invalid property if this property owner has no property with the given ID.

Reimplemented from getProperty.

Reimplemented in getProperty, getProperty.

getRotatedBoundingBox

QList< RVector > RTextBasedEntity::getRotatedBoundingBox() const

inline const

getShapes

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

virtual inline 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 > RTextBasedEntity::getSimpleTextBlocks()

inline

getTextData

virtual RTextBasedData & RTextBasedEntity::getTextData()

virtual inline

getTextHeight

double RTextBasedEntity::getTextHeight() const

inline const

getTextWidth

double RTextBasedEntity::getTextWidth() const

inline const

getVAlign

RS::VAlign RTextBasedEntity::getVAlign() const

inline const

getWidth

double RTextBasedEntity::getWidth() const

inline const

getXScale

double RTextBasedEntity::getXScale() const

inline const

isBackward

bool RTextBasedEntity::isBackward() const

inline const

isBold

bool RTextBasedEntity::isBold() const

inline const

isItalic

bool RTextBasedEntity::isItalic() const

inline const

isSimple

bool RTextBasedEntity::isSimple() const

inline const

isUpsideDown

bool RTextBasedEntity::isUpsideDown() const

inline const

scaleNonUniform

virtual QSharedPointer< REntity > RTextBasedEntity::scaleNonUniform(const RVector &scaleFactors, const RVector &center)

virtual

Reimplemented from scaleNonUniform.

setAlignmentPoint

void RTextBasedEntity::setAlignmentPoint(const RVector &alignmentPoint)

inline

setAngle

void RTextBasedEntity::setAngle(double angle)

inline

setBackward

void RTextBasedEntity::setBackward(bool on)

inline

setBold

void RTextBasedEntity::setBold(bool on)

inline

setDrawingDirection

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

inline

setFontName

void RTextBasedEntity::setFontName(const QString &fontName)

inline

setHAlign

void RTextBasedEntity::setHAlign(RS::HAlign ha)

inline

setItalic

void RTextBasedEntity::setItalic(bool on)

inline

setLineSpacingFactor

void RTextBasedEntity::setLineSpacingFactor(double lineSpacingFactor)

inline

setLineSpacingStyle

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

inline

setPosition

void RTextBasedEntity::setPosition(const RVector &position)

inline

setProperty

virtual bool RTextBasedEntity::setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)

virtual

Sets the given property to the given value.

If this property owner does not know a property with that ID, it is up to the property owner what happens. The property might be added into a list of dynamic properties or dropped.

Returns: True if the property owner was modified in any way, false otherwise.

Reimplemented from setProperty.

Reimplemented in setProperty, setProperty.

setSimple

void RTextBasedEntity::setSimple(bool on)

inline

setText

void RTextBasedEntity::setText(const QString &text)

inline

setTextHeight

void RTextBasedEntity::setTextHeight(double h)

inline

setUpsideDown

void RTextBasedEntity::setUpsideDown(bool on)

inline

setVAlign

void RTextBasedEntity::setVAlign(RS::VAlign va)

inline

setXScale

void RTextBasedEntity::setXScale(double xScale)

inline

sync

void RTextBasedEntity::sync(const RTextBasedEntity &other)

inline

getStaticPropertyTypeIds

static QSet< RPropertyTypeId > RTextBasedEntity::getStaticPropertyTypeIds()

static inline

init

static void RTextBasedEntity::init()

static

PropertyAngle

static RPropertyTypeId RTextBasedEntity::PropertyAngle

static

PropertyBackward

static RPropertyTypeId RTextBasedEntity::PropertyBackward

static

PropertyBlock

static RPropertyTypeId RTextBasedEntity::PropertyBlock

static

PropertyBold

static RPropertyTypeId RTextBasedEntity::PropertyBold

static

PropertyColor

static RPropertyTypeId RTextBasedEntity::PropertyColor

static

PropertyCustom

static RPropertyTypeId RTextBasedEntity::PropertyCustom

static

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.

PropertyDisplayedColor

static RPropertyTypeId RTextBasedEntity::PropertyDisplayedColor

static

PropertyDrawOrder

static RPropertyTypeId RTextBasedEntity::PropertyDrawOrder

static

PropertyFontName

static RPropertyTypeId RTextBasedEntity::PropertyFontName

static

PropertyHAlign

static RPropertyTypeId RTextBasedEntity::PropertyHAlign

static

PropertyHandle

static RPropertyTypeId RTextBasedEntity::PropertyHandle

static

PropertyHeight

static RPropertyTypeId RTextBasedEntity::PropertyHeight

static

PropertyItalic

static RPropertyTypeId RTextBasedEntity::PropertyItalic

static

PropertyLayer

static RPropertyTypeId RTextBasedEntity::PropertyLayer

static

PropertyLineSpacingFactor

static RPropertyTypeId RTextBasedEntity::PropertyLineSpacingFactor

static

PropertyLinetype

static RPropertyTypeId RTextBasedEntity::PropertyLinetype

static

PropertyLinetypeScale

static RPropertyTypeId RTextBasedEntity::PropertyLinetypeScale

static

PropertyLineweight

static RPropertyTypeId RTextBasedEntity::PropertyLineweight

static

PropertyPlainText

static RPropertyTypeId RTextBasedEntity::PropertyPlainText

static

PropertyPositionX

static RPropertyTypeId RTextBasedEntity::PropertyPositionX

static

PropertyPositionY

static RPropertyTypeId RTextBasedEntity::PropertyPositionY

static

PropertyPositionZ

static RPropertyTypeId RTextBasedEntity::PropertyPositionZ

static

PropertySimple

static RPropertyTypeId RTextBasedEntity::PropertySimple

static

PropertyText

static RPropertyTypeId RTextBasedEntity::PropertyText

static

PropertyType

static RPropertyTypeId RTextBasedEntity::PropertyType

static

PropertyUpsideDown

static RPropertyTypeId RTextBasedEntity::PropertyUpsideDown

static

PropertyVAlign

static RPropertyTypeId RTextBasedEntity::PropertyVAlign

static

PropertyWidth

static RPropertyTypeId RTextBasedEntity::PropertyWidth

static

PropertyXScale

static RPropertyTypeId RTextBasedEntity::PropertyXScale

static

print

virtual void RTextBasedEntity::print(QDebug dbg) const

virtual const protected

Stream operator for QDebug.

Reimplemented from print.

Reimplemented in print, print, print.