RDocumentVariables

Class in Core Module
Header: #include <src/core/RDocumentVariables.h>
Inherits: RObject

Description

This type of object is used to store document wide variables.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

	RDocumentVariables(RDocument *document)
virtual	~RDocumentVariables()
QString	addAutoVariable(double value)
void	clear()
virtual QSharedPointer< RObject >	clone() const
QSharedPointer< RDocumentVariables >	cloneToDocumentVariables() const
QStringList	getAutoVariables() const
RObject::Id	getCurrentLayerId() const
virtual QSet< RPropertyTypeId >	getCustomPropertyTypeIds() const
QString	getDimensionFont() const
QVariant	getKnownVariable(RS::KnownVariable key) const
double	getLinetypeScale() const
RS::Measurement	getMeasurement() const
virtual QPair< QVariant, RPropertyAttributes >	getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
virtual RS::EntityType	getType() const
RS::Unit	getUnit() const
bool	hasKnownVariable(RS::KnownVariable key) const
virtual void	print(QDebug dbg) const Stream operator for QDebug.
void	setCurrentLayerId(RObject::Id id)
void	setDimensionFont(const QString &f)
void	setKnownVariable(RS::KnownVariable key, const QVariant &value)
void	setKnownVariable(RS::KnownVariable key, const RColor &value)
void	setKnownVariable(RS::KnownVariable key, const RVector &value)
void	setLinetypeScale(double s)
void	setMeasurement(RS::Measurement m)
virtual bool	setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL) Sets the given property to the given value.
void	setUnit(RS::Unit u)

Static Public Functions

static RS::EntityType	getRtti()
static void	init()

Static Public Attributes

static RPropertyTypeId	PropertyCurrentLayerId
static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyDimensionFont
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyLinetypeScale
static RPropertyTypeId	PropertyProtected
static RPropertyTypeId	PropertyUnit
static RPropertyTypeId	PropertyWorkingSetBlockReferenceId

Private Attributes

RObject::Id	currentLayerId
QString	dimensionFont
QHash< RS::KnownVariable, QVariant >	knownVariables
double	linetypeScale
RS::Measurement	measurement
RS::Unit	unit
RObject::Id	workingSetBlockReferenceId

Member Documentation

RDocumentVariables

RDocumentVariables::RDocumentVariables(RDocument *document)

~RDocumentVariables

virtual RDocumentVariables::~RDocumentVariables()

virtual

addAutoVariable

QString RDocumentVariables::addAutoVariable(double value)

clear

void RDocumentVariables::clear()

clone

virtual QSharedPointer< RObject > RDocumentVariables::clone() const

virtual inline const

Reimplemented from clone.

cloneToDocumentVariables

QSharedPointer< RDocumentVariables > RDocumentVariables::cloneToDocumentVariables() const

inline const

getAutoVariables

QStringList RDocumentVariables::getAutoVariables() const

const

getCurrentLayerId

RObject::Id RDocumentVariables::getCurrentLayerId() const

inline const

getCustomPropertyTypeIds

virtual QSet< RPropertyTypeId > RDocumentVariables::getCustomPropertyTypeIds() const

virtual const

Returns: A set of all custom property IDs of properties that are available for this object.

Reimplemented from getCustomPropertyTypeIds.

getDimensionFont

QString RDocumentVariables::getDimensionFont() const

inline const

getKnownVariable

QVariant RDocumentVariables::getKnownVariable(RS::KnownVariable key) const

const

getLinetypeScale

double RDocumentVariables::getLinetypeScale() const

inline const

getMeasurement

RS::Measurement RDocumentVariables::getMeasurement() const

inline const

getProperty

virtual QPair< QVariant, RPropertyAttributes > RDocumentVariables::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.

getType

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

virtual inline const

Returns: The unique entity type, usually the same as RTTI, different for custom entities.

Reimplemented from getType.

getUnit

RS::Unit RDocumentVariables::getUnit() const

inline const

hasKnownVariable

bool RDocumentVariables::hasKnownVariable(RS::KnownVariable key) const

const

print

virtual void RDocumentVariables::print(QDebug dbg) const

virtual const

Stream operator for QDebug.

Reimplemented from print.

setCurrentLayerId

void RDocumentVariables::setCurrentLayerId(RObject::Id id)

inline

setDimensionFont

void RDocumentVariables::setDimensionFont(const QString &f)

inline

setKnownVariable

void RDocumentVariables::setKnownVariable(RS::KnownVariable key, const QVariant &value)

setKnownVariable

void RDocumentVariables::setKnownVariable(RS::KnownVariable key, const RColor &value)

setKnownVariable

void RDocumentVariables::setKnownVariable(RS::KnownVariable key, const RVector &value)

setLinetypeScale

void RDocumentVariables::setLinetypeScale(double s)

inline

setMeasurement

void RDocumentVariables::setMeasurement(RS::Measurement m)

inline

setProperty

virtual bool RDocumentVariables::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.

setUnit

void RDocumentVariables::setUnit(RS::Unit u)

inline

getRtti

static RS::EntityType RDocumentVariables::getRtti()

static inline

init

static void RDocumentVariables::init()

static

PropertyCurrentLayerId

static RPropertyTypeId RDocumentVariables::PropertyCurrentLayerId

static

PropertyCustom

static RPropertyTypeId RDocumentVariables::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.

PropertyDimensionFont

static RPropertyTypeId RDocumentVariables::PropertyDimensionFont

static

PropertyHandle

static RPropertyTypeId RDocumentVariables::PropertyHandle

static

PropertyLinetypeScale

static RPropertyTypeId RDocumentVariables::PropertyLinetypeScale

static

PropertyProtected

static RPropertyTypeId RDocumentVariables::PropertyProtected

static

PropertyUnit

static RPropertyTypeId RDocumentVariables::PropertyUnit

static

PropertyWorkingSetBlockReferenceId

static RPropertyTypeId RDocumentVariables::PropertyWorkingSetBlockReferenceId

static

currentLayerId

RObject::Id RDocumentVariables::currentLayerId

private

dimensionFont

QString RDocumentVariables::dimensionFont

private

knownVariables

QHash<RS::KnownVariable, QVariant> RDocumentVariables::knownVariables

private

linetypeScale

double RDocumentVariables::linetypeScale

private

measurement

RS::Measurement RDocumentVariables::measurement

private

unit

RS::Unit RDocumentVariables::unit

private

workingSetBlockReferenceId

RObject::Id RDocumentVariables::workingSetBlockReferenceId

private