RLayerState

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

Description

Represents a layer state (state of list of layers) in a drawing.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

	RLayerState()
	RLayerState(RDocument *document, const QString &name)
virtual	~RLayerState()
void	addLayer(QSharedPointer< RLayer > layer)
virtual QSharedPointer< RObject >	clone() const
QSharedPointer< RLayerState >	cloneToLayerState() const
QString	getCurrentLayerName() const
QString	getDescription() const
QSharedPointer< RLayer >	getLayer(const QString &layerName) const
QStringList	getLayerNames() const
QList< QSharedPointer< RLayer > >	getLayers() const
QString	getName() const
virtual QPair< QVariant, RPropertyAttributes >	getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
virtual RS::EntityType	getType() const
virtual bool	mustAlwaysClone() const
void	setCurrentLayerName(const QString &l)
void	setDescription(const QString &d)
void	setName(const QString &n)
virtual bool	setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL) Sets the given property to the given value.

Static Public Functions

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

Static Public Attributes

static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyName
static RPropertyTypeId	PropertyProtected
static RPropertyTypeId	PropertyType

Private Attributes

QString	currentLayer
QString	description
QList< QSharedPointer< RLayer > >	layers
QString	name

Member Documentation

RLayerState

RLayerState::RLayerState()

RLayerState

RLayerState::RLayerState(RDocument *document, const QString &name)

~RLayerState

virtual RLayerState::~RLayerState()

virtual

addLayer

void RLayerState::addLayer(QSharedPointer< RLayer > layer)

clone

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

virtual inline const

Reimplemented from clone.

cloneToLayerState

QSharedPointer< RLayerState > RLayerState::cloneToLayerState() const

inline const

getCurrentLayerName

QString RLayerState::getCurrentLayerName() const

inline const

getDescription

QString RLayerState::getDescription() const

inline const

getLayer

QSharedPointer< RLayer > RLayerState::getLayer(const QString &layerName) const

const

getLayerNames

QStringList RLayerState::getLayerNames() const

const

getLayers

QList< QSharedPointer< RLayer > > RLayerState::getLayers() const

const

getName

QString RLayerState::getName() const

inline const

getProperty

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

virtual inline const

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

Reimplemented from getType.

mustAlwaysClone

virtual bool RLayerState::mustAlwaysClone() const

virtual inline const

Returns: True to always clone object instead of saving diff when object changes. This can be used for complex object types which cannot be modified using properties.

Reimplemented from mustAlwaysClone.

setCurrentLayerName

void RLayerState::setCurrentLayerName(const QString &l)

inline

setDescription

void RLayerState::setDescription(const QString &d)

inline

setName

void RLayerState::setName(const QString &n)

inline

setProperty

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

getRtti

static RS::EntityType RLayerState::getRtti()

static inline

init

static void RLayerState::init()

static

PropertyCustom

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

PropertyHandle

static RPropertyTypeId RLayerState::PropertyHandle

static

PropertyName

static RPropertyTypeId RLayerState::PropertyName

static

PropertyProtected

static RPropertyTypeId RLayerState::PropertyProtected

static

PropertyType

static RPropertyTypeId RLayerState::PropertyType

static

currentLayer

QString RLayerState::currentLayer

private

description

QString RLayerState::description

private

layers

QList<QSharedPointer<RLayer> > RLayerState::layers

private

name

QString RLayerState::name

private