RPropertyTypeId

Class in Core Module
Header: #include <src/core/RPropertyTypeId.h>

Description

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. Represents unique property type IDs. Every property type an object can have has such an unique ID.

E.g. all objects of type car may have a property type called brand. This property type is uniquely identified by an instance of this class. All instances of this class are automatically unique.

class QCADCORE_EXPORT Car {
public:
static RPropertyTypeId propertyBrand;
}

RPropertyTypeId Car::propertyBrand(typeid(Car));

Scriptable: This class is available in script environments.

Copyable: Objects are cleaned up automatically by the garbage collector of the script engine.

Public Functions


	RPropertyTypeId`(const QString &customPropertyName)`
	RPropertyTypeId`(const QString &customPropertyTitle, const QString &customPropertyName)` \ nonscriptable
	RPropertyTypeId`(const RPropertyTypeId &other)`
	RPropertyTypeId`(long int id=INVALID_ID)`
void	generateId`(RS::EntityType type, const QString &groupTitle, const QString &title, bool forceNew=false, RPropertyAttributes::Options options=RPropertyAttributes::NoOptions)`
void	generateId`(RS::EntityType type, const RPropertyTypeId &other)`
QString	getCustomPropertyName`() const`
QString	getCustomPropertyTitle`() const`
long int	getId`() const`
QString	getPropertyGroupTitle`() const`
QString	getPropertyTitle`() const`
bool	isCustom`() const`
bool	isValid`() const`
bool	operator!=`(const RPropertyTypeId &other) const` != operator
bool	operator<`(const RPropertyTypeId &other) const` < operator
RPropertyTypeId &	operator=`(const RPropertyTypeId &other)`
bool	operator==`(const RPropertyTypeId &other) const` == operator
void	setCustomPropertyName`(const QString &n)`
void	setCustomPropertyTitle`(const QString &t)`
void	setId`(long int id)`

Static Public Functions


static RPropertyTypeId	getPropertyTypeId`(const QString &groupTitle, const QString &title)`
static QSet< RPropertyTypeId >	getPropertyTypeIds`(RS::EntityType type, RPropertyAttributes::Option=RPropertyAttributes::NoOptions)` Gets all property type IDs that where registered for the given class.
static bool	hasPropertyType`(RS::EntityType type, RPropertyTypeId propertyTypeId)`

Static Public Attributes


static const long int	INVALID_ID

Private Attributes


QString	customPropertyName
QString	customPropertyTitle
long int	id
RPropertyAttributes::Options	options

Static Private Attributes


static QList< RPropertyAttributes::Option >	cachedOptionList
static long int	counter
static QMap< long int, QPair< QString, QString > >	idToTitleMap
static QMap< RS::EntityType, QSet< RPropertyTypeId > >	propertyTypeByObjectMap
static QMap< QPair< RS::EntityType, RPropertyAttributes::Option >, QSet< RPropertyTypeId > >	propertyTypeByObjectOptionMap
static QMap< QString, QMap< QString, RPropertyTypeId > >	titleToIdMap

Member Documentation

RPropertyTypeId

RPropertyTypeId::RPropertyTypeId(const QString &customPropertyName)

RPropertyTypeId

RPropertyTypeId::RPropertyTypeId(const QString &customPropertyTitle, const QString &customPropertyName)

\ nonscriptable

RPropertyTypeId

RPropertyTypeId::RPropertyTypeId(const RPropertyTypeId &other)

RPropertyTypeId

RPropertyTypeId::RPropertyTypeId(long int id=INVALID_ID)

generateId

void RPropertyTypeId::generateId(RS::EntityType type, const QString &groupTitle, const QString &title, bool forceNew=false, RPropertyAttributes::Options options=RPropertyAttributes::NoOptions)

generateId

void RPropertyTypeId::generateId(RS::EntityType type, const RPropertyTypeId &other)

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

getCustomPropertyName

QString RPropertyTypeId::getCustomPropertyName() const

const

Returns: The name (key) of the custom property.

getCustomPropertyTitle

QString RPropertyTypeId::getCustomPropertyTitle() const

const

getId

long int RPropertyTypeId::getId() const

const

Returns: The internal ID of this property.

getPropertyGroupTitle

QString RPropertyTypeId::getPropertyGroupTitle() const

const

Returns: The property group title of the given property.

getPropertyTitle

QString RPropertyTypeId::getPropertyTitle() const

const

Returns: The property title of the given property.

isCustom

bool RPropertyTypeId::isCustom() const

const

isValid

bool RPropertyTypeId::isValid() const

const

operator!=

bool RPropertyTypeId::operator!=(const RPropertyTypeId &other) const

const

!= operator

operator<

bool RPropertyTypeId::operator<(const RPropertyTypeId &other) const

const

< operator

operator=

RPropertyTypeId & RPropertyTypeId::operator=(const RPropertyTypeId &other)

operator==

bool RPropertyTypeId::operator==(const RPropertyTypeId &other) const

const

== operator

setCustomPropertyName

void RPropertyTypeId::setCustomPropertyName(const QString &n)

setCustomPropertyTitle

void RPropertyTypeId::setCustomPropertyTitle(const QString &t)

setId

void RPropertyTypeId::setId(long int id)

getPropertyTypeId

static RPropertyTypeId RPropertyTypeId::getPropertyTypeId(const QString &groupTitle, const QString &title)

static

getPropertyTypeIds

static QSet< RPropertyTypeId > RPropertyTypeId::getPropertyTypeIds(RS::EntityType type, RPropertyAttributes::Option=RPropertyAttributes::NoOptions)

static

Gets all property type IDs that where registered for the given class.

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

Parameters:

classInfo: The class info, e.g. typeid(ObjectA)
geometryOnly: Only return geometric properties

Returns: a set of property type ID pointers or an empty set if the class has no registered property types.

hasPropertyType

static bool RPropertyTypeId::hasPropertyType(RS::EntityType type, RPropertyTypeId propertyTypeId)

static

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

Return values:

true: if the given class has the given property

INVALID_ID

static const long int RPropertyTypeId::INVALID_ID = -1

static

customPropertyName

QString RPropertyTypeId::customPropertyName

private

customPropertyTitle

QString RPropertyTypeId::customPropertyTitle

private

id

long int RPropertyTypeId::id

private

options

RPropertyAttributes::Options RPropertyTypeId::options

private

cachedOptionList

static QList< RPropertyAttributes::Option > RPropertyTypeId::cachedOptionList

static private

counter

static long int RPropertyTypeId::counter = 0

static private

This file is part of the QCAD project.

You should have received a copy of the GNU General Public License along with QCAD.

idToTitleMap

static QMap< long int, QPair< QString, QString > > RPropertyTypeId::idToTitleMap

static private

propertyTypeByObjectMap

static QMap< RS::EntityType, QSet< RPropertyTypeId > > RPropertyTypeId::propertyTypeByObjectMap

static private

propertyTypeByObjectOptionMap

static QMap< QPair< RS::EntityType, RPropertyAttributes::Option >, QSet< RPropertyTypeId > > RPropertyTypeId::propertyTypeByObjectOptionMap

static private

titleToIdMap

static QMap< QString, QMap< QString, RPropertyTypeId > > RPropertyTypeId::titleToIdMap

static private