RBlock

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

Description

Represents a block definition in a drawing.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

	RBlock()
	RBlock(RDocument *document, const QString &name, const RVector &origin)
virtual	~RBlock()
void	bindXRef(bool useTransaction=true)
virtual QSharedPointer< RObject >	clone() const
QSharedPointer< RBlock >	cloneToBlock() const
QString	getFullXRefFilePath() const
RObject::Id	getLayoutId() const
QString	getLayoutName() const
QString	getName() const
RVector	getOrigin() const
virtual QPair< QVariant, RPropertyAttributes >	getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
virtual RS::EntityType	getType() const
QSet< QString >	getXRefBlockNames() const
QString	getXRefFileName() const
QSet< QString >	getXRefLayerNames() const
bool	hasLayout() const
bool	isAnonymous() const
bool	isFromXRef() const Block was imported as part of an XRef.
bool	isFrozen() const
bool	isModelSpace() const
bool	isOwnedByReference() const
bool	isPixelUnit() const
bool	isXRef() const Block is an XRef.
bool	isXRefLoaded() const
bool	loadXRef()
void	setAnonymous(bool on)
virtual void	setCustomProperty(const QString &title, const QString &key, const QVariant &value) Sets a custom property with the given name.
void	setFrozen(bool on)
void	setLayoutId(RObject::Id layoutId)
void	setName(const QString &n)
void	setOrigin(const RVector &origin)
void	setOwnedByReference(bool on)
void	setPixelUnit(bool on)
virtual bool	setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL) Sets the given property to the given value.
void	setXRefFileName(const QString &f)
void	setXRefLoaded(bool on)
void	unloadXRef()

Static Public Functions

static RBlockProxy *	getBlockProxy()
static RS::EntityType	getRtti()
static bool	hasProxy()
static void	init()
static void	setBlockProxy(RBlockProxy *p)

Static Public Attributes

static const QString	modelSpaceName
static const QString	paperSpaceName
static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyFrozen
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyLayout
static RPropertyTypeId	PropertyName
static RPropertyTypeId	PropertyOriginX
static RPropertyTypeId	PropertyOriginY
static RPropertyTypeId	PropertyOriginZ
static RPropertyTypeId	PropertyOwnedByReference
static RPropertyTypeId	PropertyPixelUnit
static RPropertyTypeId	PropertyType
static RPropertyTypeId	PropertyXRefFileName

Protected Functions

virtual void	print(QDebug dbg) const

Private Attributes

bool	anonymous
bool	frozen
RObject::Id	layoutId
QString	name
RVector	origin
bool	ownedByReference
bool	pixelUnit
QString	xRefFileName
bool	xRefLoaded

Static Private Attributes

static RBlockProxy *	blockProxy

Member Documentation

RBlock

RBlock::RBlock()

RBlock

RBlock::RBlock(RDocument *document, const QString &name, const RVector &origin)

~RBlock

virtual RBlock::~RBlock()

virtual

bindXRef

void RBlock::bindXRef(bool useTransaction=true)

clone

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

virtual inline const

Reimplemented from clone.

cloneToBlock

QSharedPointer< RBlock > RBlock::cloneToBlock() const

inline const

getFullXRefFilePath

QString RBlock::getFullXRefFilePath() const

inline const

getLayoutId

RObject::Id RBlock::getLayoutId() const

inline const

getLayoutName

QString RBlock::getLayoutName() const

const

getName

QString RBlock::getName() const

inline const

getOrigin

RVector RBlock::getOrigin() const

inline const

getProperty

virtual QPair< QVariant, RPropertyAttributes > RBlock::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 RBlock::getType() const

virtual inline const

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

Reimplemented from getType.

getXRefBlockNames

QSet< QString > RBlock::getXRefBlockNames() const

const

Returns: List of block names that depend on this XRef block.

getXRefFileName

QString RBlock::getXRefFileName() const

inline const

getXRefLayerNames

QSet< QString > RBlock::getXRefLayerNames() const

const

Returns: List of layer names that depend on this XRef block.

hasLayout

bool RBlock::hasLayout() const

inline const

isAnonymous

bool RBlock::isAnonymous() const

inline const

isFromXRef

bool RBlock::isFromXRef() const

inline const

Block was imported as part of an XRef.

isFrozen

bool RBlock::isFrozen() const

inline const

isModelSpace

bool RBlock::isModelSpace() const

inline const

isOwnedByReference

bool RBlock::isOwnedByReference() const

inline const

isPixelUnit

bool RBlock::isPixelUnit() const

inline const

isXRef

bool RBlock::isXRef() const

inline const

Block is an XRef.

isXRefLoaded

bool RBlock::isXRefLoaded() const

inline const

loadXRef

bool RBlock::loadXRef()

inline

setAnonymous

void RBlock::setAnonymous(bool on)

inline

setCustomProperty

virtual void RBlock::setCustomProperty(const QString &title, const QString &key, const QVariant &value)

virtual

Sets a custom property with the given name.

Reimplemented from setCustomProperty.

setFrozen

void RBlock::setFrozen(bool on)

inline

setLayoutId

void RBlock::setLayoutId(RObject::Id layoutId)

inline

setName

void RBlock::setName(const QString &n)

setOrigin

void RBlock::setOrigin(const RVector &origin)

inline

setOwnedByReference

void RBlock::setOwnedByReference(bool on)

inline

setPixelUnit

void RBlock::setPixelUnit(bool on)

inline

setProperty

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

setXRefFileName

void RBlock::setXRefFileName(const QString &f)

inline

setXRefLoaded

void RBlock::setXRefLoaded(bool on)

inline

unloadXRef

void RBlock::unloadXRef()

inline

getBlockProxy

static RBlockProxy * RBlock::getBlockProxy()

static inline

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

getRtti

static RS::EntityType RBlock::getRtti()

static inline

hasProxy

static bool RBlock::hasProxy()

static inline

init

static void RBlock::init()

static

setBlockProxy

static void RBlock::setBlockProxy(RBlockProxy *p)

static inline

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

modelSpaceName

static const QString RBlock::modelSpaceName = "*Model_Space"

static

paperSpaceName

static const QString RBlock::paperSpaceName = "*Paper_Space"

static

PropertyCustom

static RPropertyTypeId RBlock::PropertyCustom

static

PropertyFrozen

static RPropertyTypeId RBlock::PropertyFrozen

static

PropertyHandle

static RPropertyTypeId RBlock::PropertyHandle

static

PropertyLayout

static RPropertyTypeId RBlock::PropertyLayout

static

PropertyName

static RPropertyTypeId RBlock::PropertyName

static

PropertyOriginX

static RPropertyTypeId RBlock::PropertyOriginX

static

PropertyOriginY

static RPropertyTypeId RBlock::PropertyOriginY

static

PropertyOriginZ

static RPropertyTypeId RBlock::PropertyOriginZ

static

PropertyOwnedByReference

static RPropertyTypeId RBlock::PropertyOwnedByReference

static

PropertyPixelUnit

static RPropertyTypeId RBlock::PropertyPixelUnit

static

PropertyType

static RPropertyTypeId RBlock::PropertyType

static

PropertyXRefFileName

static RPropertyTypeId RBlock::PropertyXRefFileName

static

print

virtual void RBlock::print(QDebug dbg) const

virtual const protected

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

Reimplemented from print.

anonymous

bool RBlock::anonymous

private

frozen

bool RBlock::frozen

private

layoutId

RObject::Id RBlock::layoutId

private

name

QString RBlock::name

private

origin

RVector RBlock::origin

private

ownedByReference

bool RBlock::ownedByReference

private

pixelUnit

bool RBlock::pixelUnit

private

xRefFileName

QString RBlock::xRefFileName

private

xRefLoaded

bool RBlock::xRefLoaded

private

blockProxy

static RBlockProxy * RBlock::blockProxy = 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.