QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RTextBasedData Class Reference

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

#include <RTextBasedData.h>

Inheritance diagram for RTextBasedData:
REntityData RPainterPathSource RAttributeData RAttributeDefinitionData RTextData

List of all members.

Public Member Functions

virtual bool flipHorizontal ()
virtual bool flipVertical ()
RVector getAlignmentPoint () const
double getAngle () const
virtual RBox getBoundingBox (bool ignoreEmpty=false) const
virtual QList< RVectorgetCenterPoints (const RBox &queryBox=RDEFAULT_RBOX) const
virtual RVector getClosestPointOnEntity (const RVector &point, double range, bool limited) const
virtual QSharedPointer< RShapegetClosestShape (const RVector &pos, double range=RNANDOUBLE) 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< RVectorgetEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const
virtual QString getEscapedText (bool escapeUnicode=false) const
virtual QList< QSharedPointer
< RShape > > 
getExploded () 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< RVectorgetMiddlePoints (const RBox &queryBox=RDEFAULT_RBOX) const
virtual QList< RPainterPathgetPainterPaths (bool draft=false) const
virtual QString getPlainText () const
virtual RVector getPointOnEntity () const
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
RVector getPosition () const
virtual QList< RVectorgetReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
virtual QString getRenderedText (bool escapeUnicode=false) const
virtual QList< QSharedPointer
< RShape > > 
getShapes (const RBox &queryBox=RDEFAULT_RBOX) const
virtual QString getText () const
double getTextHeight () const
double getTextWidth () const
 Width of the text box used for line wrapping (not supported).
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 isBold () const
virtual bool isDirty () const
bool isItalic () const
bool isSimple () const
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)
 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)
 RTextBasedData (RDocument *document=NULL)
 Copyright (c) 2011-2013 by Andrew Mustun.
 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)
virtual bool scale (const RVector &scaleFactors, const RVector &center)
void setAlignmentPoint (const RVector &alignmentPoint)
void setAngle (double angle)
void setBold (bool on)
void setDrawingDirection (RS::TextDrawingDirection drawingDirection)
void setFontName (const QString &fontName)
void setHAlign (RS::HAlign halign)
void setItalic (bool on)
void setLineSpacingFactor (double lineSpacingFactor)
void setLineSpacingStyle (RS::TextLineSpacingStyle lineSpacingStyle)
void setPosition (const RVector &position)
void setSimple (bool on)
void setText (const QString &text)
void setTextHeight (double h)
void setTextWidth (double w)
void setVAlign (RS::VAlign valign)
void setXScale (double xScale)
void sync (const RTextBasedData &other)
virtual void update () const
 Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
virtual ~RTextBasedData ()
- Public Member Functions inherited from REntityData
virtual const RShapecastToConstShape () const
virtual RShapecastToShape ()
RBlock::Id getBlockId () const
QString getBlockName () const
virtual QList< RBoxgetBoundingBoxes (bool ignoreEmpty=false) const
virtual RColor getColor () const
virtual RColor getColor (bool resolve, const QStack< REntity * > &blockRefStack) const
RDocumentgetDocument ()
const RDocumentgetDocument () const
virtual int getDrawOrder () const
virtual QList< RVectorgetInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 Can be overwritten to return internal, resolved reference points.
virtual QList< RVectorgetIntersectionPoints (const REntityData &other, bool limited=true, bool same=false, const RBox &queryBox=RDEFAULT_RBOX) const
 Override to disable intersection point.
virtual QList< RVectorgetIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const
RLayer::Id getLayerId () const
QString getLayerName () const
virtual RLinetype::Id getLinetypeId () const
virtual RLinetype::Id getLinetypeId (bool resolve, const QStack< REntity * > &blockRefStack) const
virtual RLinetypePattern getLinetypePattern () const
virtual double getLinetypeScale () const
virtual RLineweight::Lineweight getLineweight () const
virtual RLineweight::Lineweight getLineweight (bool resolve, const QStack< REntity * > &blockRefStack) const
double getLineweightInUnits (const QStack< REntity * > &blockRefStack) const
RObject::Id getParentId () const
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
virtual bool isInside (const RBox &box) const
virtual bool isOnEntity (const RVector &point, bool limited=true) const
virtual bool isSelected () const
virtual bool mirror (const RVector &axis1, const RVector &axis2)
 REntityData (RDocument *document=NULL)
 Copyright (c) 2011-2013 by Andrew Mustun.
virtual bool scale (double scaleFactor, const RVector &center=RDEFAULT_RVECTOR)
virtual void setBlockId (RBlock::Id blockId)
void setColor (const RColor &color)
void setDocument (RDocument *document)
virtual void setDrawOrder (int drawOrder)
 Sets the draw order of this entity.
virtual void setLayerId (RLayer::Id layerId)
virtual void setLinetypeId (RLinetype::Id linetypeId)
virtual void setLinetypePattern (const RLinetypePattern &p)
virtual void setLinetypeScale (double linetypeScale)
void setLineweight (RLineweight::Lineweight lineweight)
virtual void setParentId (RObject::Id parentId)
virtual void setSelected (bool on)
 Selects or deselects this entity.
virtual bool stretch (const RPolyline &area, const RVector &offset)
 Stretches the end points of this entity that are inside area by offset.
virtual ~REntityData ()
- Public Member Functions inherited from RPainterPathSource
virtual ~RPainterPathSource ()
virtual ~RPainterPathSource ()

Static Public Member Functions

static QString escapeUnicode (const QString &str)
static QString toEscapedText (const QTextDocument &textDocument, const RColor &initialColor, double fontHeightFactor=1.0)
 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 Member Functions

 RTextBasedData (RDocument *document, const RTextBasedData &data)

Protected Attributes

RVector alignmentPoint
double angle
bool bold
RBox boundingBox
bool dirty
RS::TextDrawingDirection drawingDirection
QString fontName
bool gotDraft
double height
RS::HAlign horizontalAlignment
bool italic
double lineSpacingFactor
RS::TextLineSpacingStyle lineSpacingStyle
QList< RPainterPathpainterPaths
RVector position
bool simple
QString text
double textHeight
double textWidth
RS::VAlign verticalAlignment
double width
double xScale
- Protected Attributes inherited from REntityData
RBlock::Id blockId
RColor color
RDocumentdocument
int drawOrder
RLayer::Id layerId
RLinetype::Id linetypeId
double linetypeScale
RLineweight::Lineweight lineweight
RObject::Id parentId
bool selectionStatus

Friends

QDebug operator<< (QDebug dbg, const RTextBasedData &t)
class RTextBasedEntity

Detailed 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 wrapped for script environments.
Shared Pointer Support:
Script wrappers of this class support wrapping in QSharedPointer.
Copyable:
Script wrappers of this class should pass objects by reference.

Constructor & Destructor Documentation

RTextBasedData::RTextBasedData ( RDocument document,
const RTextBasedData data 
)
protected
RTextBasedData::RTextBasedData ( RDocument document = NULL)

Copyright (c) 2011-2013 by Andrew Mustun.

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.

RTextBasedData::RTextBasedData ( const RVector position,
const RVector alignmentPoint,
double  height,
double  textWidth,
RS::VAlign  valign,
RS::HAlign  halign,
RS::TextDrawingDirection  drawingDirection,
RS::TextLineSpacingStyle  lineSpacingStyle,
double  lineSpacingFactor,
const QString &  text,
const QString &  fontName,
bool  bold,
bool  italic,
double  angle,
bool  simple 
)
Parameters:
positionInsertion point (see DXF code 10 doc).
alignmentPointAlignement point of text (see DXF code 11 doc).
heightNominal (initial) text height
textWidthReference rectangle width for wrapping (not supported)
valignVertical alignment
halignHorizontal alignment
drawingDirectionDrawing direction
lineSpacingStyleLine spacing style
lineSpacingFactorLine spacing factor
textText string
fontNameText font name
angleRotation angle in rad
virtual RTextBasedData::~RTextBasedData ( )
inlinevirtual

Member Function Documentation

QString RTextBasedData::escapeUnicode ( const QString &  str)
static
bool RTextBasedData::flipHorizontal ( )
virtual

Reimplemented from REntityData.

bool RTextBasedData::flipVertical ( )
virtual

Reimplemented from REntityData.

RVector RTextBasedData::getAlignmentPoint ( ) const
inline
double RTextBasedData::getAngle ( ) const
inline
RBox RTextBasedData::getBoundingBox ( bool  ignoreEmpty = false) const
virtual
Returns:
The bounding box that contains this entity.

Reimplemented from REntityData.

virtual QList<RVector> RTextBasedData::getCenterPoints ( const RBox queryBox = RDEFAULT_RBOX) const
inlinevirtual
Returns:
Vector of center points of this entity. Used for snap to center points.

Reimplemented from REntityData.

RVector RTextBasedData::getClosestPointOnEntity ( const RVector point,
double  range,
bool  limited 
) const
virtual
Returns:
Closest point to point on this entity. Used for snap to points on entity.

Reimplemented from REntityData.

virtual QSharedPointer<RShape> RTextBasedData::getClosestShape ( const RVector pos,
double  range = RNANDOUBLE 
) const
inlinevirtual
Returns:
The one shape that is part of this entity which is the closest to the given position.

Reimplemented from REntityData.

double RTextBasedData::getDistanceTo ( const RVector point,
bool  limited = true,
double  range = 0.0,
bool  draft = false,
double  strictRange = RMAXDOUBLE 
) const
virtual
Returns:
The shortest distance from this entity to the given point.

Reimplemented from REntityData.

RS::TextDrawingDirection RTextBasedData::getDrawingDirection ( ) const
inline
virtual QList<RVector> RTextBasedData::getEndPoints ( const RBox queryBox = RDEFAULT_RBOX) const
inlinevirtual
Returns:
Vector of end points of this entity. Used for snap to end points.

Reimplemented from REntityData.

QString RTextBasedData::getEscapedText ( bool  escapeUnicode = false) const
virtual
QList< QSharedPointer< RShape > > RTextBasedData::getExploded ( ) const
virtual
QString RTextBasedData::getFontName ( ) const
inline
RS::HAlign RTextBasedData::getHAlign ( ) const
inline
double RTextBasedData::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 RTextBasedData::getLineSpacingFactor ( ) const
inline
RS::TextLineSpacingStyle RTextBasedData::getLineSpacingStyle ( ) const
inline
QFont RTextBasedData::getMainFont ( ) const
virtual
virtual QList<RVector> RTextBasedData::getMiddlePoints ( const RBox queryBox = RDEFAULT_RBOX) const
inlinevirtual
Returns:
Vector of middle points of this entity. Used for snap to middle points.

Reimplemented from REntityData.

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

Implements RPainterPathSource.

QString RTextBasedData::getPlainText ( ) const
virtual
RVector RTextBasedData::getPointOnEntity ( ) const
virtual
Returns:
A point that is on the entity. Used to check if an entity is inside a polygon.

Reimplemented from REntityData.

virtual QList<RVector> RTextBasedData::getPointsWithDistanceToEnd ( double  distance,
RS::From  from = RS::FromAny,
const RBox queryBox = RDEFAULT_RBOX 
) const
inlinevirtual
Returns:
Points on entity with given distance to either endpoint. Used for snap to points with distance on entity.

Reimplemented from REntityData.

RVector RTextBasedData::getPosition ( ) const
inline
QList< RVector > RTextBasedData::getReferencePoints ( RS::ProjectionRenderingHint  hint = RS::RenderTop) const
virtual
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.

Implements REntityData.

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

Reimplemented in RAttributeDefinitionData, and RAttributeData.

QList< QSharedPointer< RShape > > RTextBasedData::getShapes ( const RBox queryBox = RDEFAULT_RBOX) const
virtual
Returns:
Shapes that represent the geometry of this entity.

Reimplemented from REntityData.

virtual QString RTextBasedData::getText ( ) const
inlinevirtual
double RTextBasedData::getTextHeight ( ) const
inline
double RTextBasedData::getTextWidth ( ) const
inline

Width of the text box used for line wrapping (not supported).

RS::VAlign RTextBasedData::getVAlign ( ) const
inline
double RTextBasedData::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 RTextBasedData::getXScale ( ) const
inline
bool RTextBasedData::intersectsWith ( const RShape shape) const
virtual
Returns:
True if this entity intersects with the given shape, false otherwise.
Todo:
better to pass another entity data object?

Reimplemented from REntityData.

bool RTextBasedData::isBold ( ) const
inline
bool RTextBasedData::isDirty ( ) const
virtual
bool RTextBasedData::isItalic ( ) const
inline
bool RTextBasedData::isSimple ( ) const
inline
bool RTextBasedData::isValid ( ) const
inline
bool RTextBasedData::mirror ( const RLine axis)
virtual

Reimplemented from REntityData.

bool RTextBasedData::move ( const RVector offset)
virtual

Moves this entity by the given offset.

Reimplemented from REntityData.

bool RTextBasedData::moveReferencePoint ( const RVector referencePoint,
const RVector targetPoint 
)
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.

Implements REntityData.

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

Reimplemented from REntityData.

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

Reimplemented from REntityData.

void RTextBasedData::setAlignmentPoint ( const RVector alignmentPoint)
inline
void RTextBasedData::setAngle ( double  angle)
inline
void RTextBasedData::setBold ( bool  on)
inline
void RTextBasedData::setDrawingDirection ( RS::TextDrawingDirection  drawingDirection)
inline
void RTextBasedData::setFontName ( const QString &  fontName)
inline
void RTextBasedData::setHAlign ( RS::HAlign  halign)
inline
void RTextBasedData::setItalic ( bool  on)
inline
void RTextBasedData::setLineSpacingFactor ( double  lineSpacingFactor)
inline
void RTextBasedData::setLineSpacingStyle ( RS::TextLineSpacingStyle  lineSpacingStyle)
inline
void RTextBasedData::setPosition ( const RVector position)
inline
void RTextBasedData::setSimple ( bool  on)
inline
void RTextBasedData::setText ( const QString &  text)
void RTextBasedData::setTextHeight ( double  h)
inline
void RTextBasedData::setTextWidth ( double  w)
inline
void RTextBasedData::setVAlign ( RS::VAlign  valign)
inline
void RTextBasedData::setXScale ( double  xScale)
inline
void RTextBasedData::sync ( const RTextBasedData other)
QString RTextBasedData::toEscapedText ( const QTextDocument &  textDocument,
const RColor initialColor,
double  fontHeightFactor = 1.0 
)
static

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

Parameters:
fontHeightFactorfactor applied to all font heights. This allows the text edit to use a bigger / smaller font that needed in the end.
QString RTextBasedData::toRichText ( const QString &  escapedText,
const QFont &  mainFont,
double  fontHeightFactor = 1.0 
)
static
Returns:
HTML representing this text.
void RTextBasedData::update ( ) const
virtual

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

Reimplemented from REntityData.


Friends And Related Function Documentation

QDebug operator<< ( QDebug  dbg,
const RTextBasedData t 
)
friend
   \par Non-Scriptable:

This function is not available in script environments.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

HTML helper function.

friend class RTextBasedEntity
friend

Member Data Documentation

RVector RTextBasedData::alignmentPoint
protected
double RTextBasedData::angle
protected
bool RTextBasedData::bold
protected
RBox RTextBasedData::boundingBox
mutableprotected
bool RTextBasedData::dirty
mutableprotected
RS::TextDrawingDirection RTextBasedData::drawingDirection
protected
QString RTextBasedData::fontName
protected
bool RTextBasedData::gotDraft
mutableprotected
double RTextBasedData::height
mutableprotected
RS::HAlign RTextBasedData::horizontalAlignment
protected
bool RTextBasedData::italic
protected
double RTextBasedData::lineSpacingFactor
protected
RS::TextLineSpacingStyle RTextBasedData::lineSpacingStyle
protected
QList<RPainterPath> RTextBasedData::painterPaths
mutableprotected
RVector RTextBasedData::position
protected
bool RTextBasedData::simple
protected
QString RTextBasedData::text
protected
double RTextBasedData::textHeight
protected
double RTextBasedData::textWidth
protected
RS::VAlign RTextBasedData::verticalAlignment
protected
double RTextBasedData::width
mutableprotected
double RTextBasedData::xScale
protected

The documentation for this class was generated from the following files: