KoProperties Class Reference

#include <KoProperties.h>

Inheritance diagram for KoProperties:

Public Member Functions
bool	boolProperty (const QString &name, bool defaultValue=false) const
bool	contains (const QString &key) const
qreal	doubleProperty (const QString &name, qreal defaultValue=0.0) const
int	intProperty (const QString &name, int defaultValue=0) const
bool	isEmpty () const
	KoProperties ()
	KoProperties (const KoProperties &other)
void	load (const QDomElement &root)
bool	load (const QString &string)
bool	operator== (const KoProperties &other) const
QVariant	property (const QString &name) const
bool	property (const QString &name, QVariant &value) const
QMapIterator< QString, QVariant >	propertyIterator () const
void	save (QDomElement &root) const
void	setProperty (const QString &name, const QVariant &value)
QString	store (const QString &root) const
	Create a serialized version of these properties (as XML) with root as the root element.
QString	stringProperty (const QString &name, const QString &defaultValue=QString()) const
QVariant	value (const QString &key) const
	~KoProperties ()

Public Attributes
QMap< QString, QVariant >	properties

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

A KoProperties is the (de-)serializable representation of a key-value map. The serialisation format is XML.

Definition at line 14 of file KoProperties.cpp.

Constructor & Destructor Documentation

KoProperties() [1/2]

KoProperties::KoProperties

(

)

Create a new properties object

Definition at line 20 of file KoProperties.cpp.

        : d(new Private())
{
}

KoProperties() [2/2]

KoProperties::KoProperties

(

const KoProperties &

other

)

Copy constructor

Definition at line 25 of file KoProperties.cpp.

        : d(new Private())
{
    d->properties = rhs.d->properties;
}

References d.

~KoProperties()

KoProperties::~KoProperties

(

)

Definition at line 31 of file KoProperties.cpp.

{
    delete d;
}

References d.

Member Function Documentation

boolProperty()

bool KoProperties::boolProperty	(	const QString &	name,
		bool	defaultValue = false ) const

Return a boolean property by name.

Parameters

name	the name (or key) with which the variant was registered.
defaultValue	the default value, should there not be any property by the name this will be returned.

Definition at line 154 of file KoProperties.cpp.

{
    const QVariant v = property(name);
    if (v.isValid())
        return v.toBool();
    else
        return def;
}

References property(), and v.

contains()

bool KoProperties::contains

(

const QString &

key

)

const

Returns true if the specified key is present in this properties object.

Definition at line 172 of file KoProperties.cpp.

{
    return d->properties.contains(key);
}

References d.

doubleProperty()

qreal KoProperties::doubleProperty	(	const QString &	name,
		qreal	defaultValue = 0.0 ) const

Return a qreal property by name.

Parameters

name	the name (or key) with which the variant was registered.
defaultValue	the default value, should there not be any property by the name this will be returned.

Definition at line 145 of file KoProperties.cpp.

{
    const QVariant v = property(name);
    if (v.isValid())
        return v.toDouble();
    else
        return def;
}

References property(), and v.

intProperty()

int KoProperties::intProperty	(	const QString &	name,
		int	defaultValue = 0 ) const

Return an integer property by name. A typical usage:

KoProperties *props = new KoProperties();
props->setProperty("age", 25);
int age = props->intProperty("age");

Returns

an integer property by name

Parameters

name	the name (or key) with which the variant was registered.
defaultValue	the default value, should there not be any property by the name this will be returned.

See also

property() stringProperty()

Definition at line 135 of file KoProperties.cpp.

{
    const QVariant v = property(name);
    if (v.isValid())
        return v.toInt();
    else
        return def;
 
}

References property(), and v.

isEmpty()

bool KoProperties::isEmpty

(

)

const

Returns

true if this KoProperties object does not contain any properties.

Definition at line 42 of file KoProperties.cpp.

{
    return d->properties.isEmpty();
}

References d.

load() [1/2]

void KoProperties::load

(

const QDomElement &

root

)

Fill the properties object from the XML dom node.

load() does not touch existing properties if loading fails.

Parameters

root	the root node of the properties subtree.

Definition at line 47 of file KoProperties.cpp.

{
    d->properties.clear();
 
    QDomElement e = root;
    QDomNode n = e.firstChild();
 
    while (!n.isNull()) {
        // We don't nest elements.
        QDomElement e = n.toElement();
        if (!e.isNull()) {
            if (e.tagName() == "property") {
                const QString name = e.attribute("name");
                const QString type = e.attribute("type");
                const QString value = e.text();
                QDataStream in(QByteArray::fromBase64(value.toLatin1()));
                QVariant v;
                in >> v;
                d->properties[name] = v;
            }
        }
        n = n.nextSibling();
    }
}

References d, v, and value().

load() [2/2]

bool KoProperties::load

(

const QString &

string

)

Fill the properties object from the XML encoded representation in string.

load() does not touch existing properties if loading fails.

Parameters

string

the stored properties.

Returns

false if loading failing, true if it succeeded

Definition at line 72 of file KoProperties.cpp.

{
    QDomDocument doc;
 
    if (!doc.setContent(s))
        return false;
    load(doc.documentElement());
 
    return true;
}

References load().

operator==()

bool KoProperties::operator==

(

const KoProperties &

other

)

const

Definition at line 182 of file KoProperties.cpp.

{
    if (d->properties.count() != other.d->properties.count())
        return false;
    Q_FOREACH (const QString & key, d->properties.keys()) {
        if (other.d->properties.value(key) != d->properties.value(key))
            return false;
    }
    return true;
}

References d.

property() [1/2]

QVariant KoProperties::property

(

const QString &

name

)

const

Return a property by name, wrapped in a QVariant. A typical usage:

KoProperties *props = new KoProperties();
props->setProperty("name", "Marcy");
props->setProperty("age", 25);
QString name = props->property("name").toString();
int age = props->property("age").toInt();

Returns

a property by name, wrapped in a QVariant.

Parameters

name	the name (or key) with which the variant was registered.

See also

intProperty() stringProperty()

Definition at line 129 of file KoProperties.cpp.

{
    return d->properties.value(name, QVariant());
}

References d.

property() [2/2]

bool KoProperties::property	(	const QString &	name,
		QVariant &	value ) const

Set value to the value associated with property name

Returns

false if the specified property did not exist.

Definition at line 118 of file KoProperties.cpp.

{
    QMap<QString, QVariant>::const_iterator it = d->properties.constFind(name);
    if (it == d->properties.constEnd()) {
        return false;
    } else {
        value = *it;
        return true;
    }
}

References d, and value().

propertyIterator()

QMapIterator< QString, QVariant > KoProperties::propertyIterator

(

)

const

Returns an iterator over the properties. The iterator is not suitable for adding or removing properties.

Definition at line 36 of file KoProperties.cpp.

{
    return QMapIterator<QString, QVariant>(d->properties);
}

References d.

save()

void KoProperties::save

(

QDomElement &

root

)

const

Definition at line 83 of file KoProperties.cpp.

{
    QDomDocument doc = root.ownerDocument();
    QMap<QString, QVariant>::Iterator it;
    for (it = d->properties.begin(); it != d->properties.end(); ++it) {
        QDomElement e = doc.createElement("property");
        e.setAttribute("name", QString(it.key().toLatin1()));
        QVariant v = it.value();
        e.setAttribute("type", v.typeName());
 
        QByteArray bytes;
        QDataStream out(&bytes, QIODevice::WriteOnly);
        out << v;
        QDomText text = doc.createCDATASection(QString::fromLatin1(bytes.toBase64()));
        e.appendChild(text);
        root.appendChild(e);
    }
}

References d, and v.

setProperty()

void KoProperties::setProperty	(	const QString &	name,
		const QVariant &	value )

Set the property with name to value.

Definition at line 112 of file KoProperties.cpp.

{
    // If there's an existing value for this name already, replace it.
    d->properties.insert(name, value);
}

References d, and value().

store()

QString KoProperties::store

(

const QString &

root

)

const

Create a serialized version of these properties (as XML) with root as the root element.

Parameters

root	as the root element in the generated XML.

Definition at line 102 of file KoProperties.cpp.

{
    QDomDocument doc = QDomDocument(s);
    QDomElement root = doc.createElement(s);
    doc.appendChild(root);
 
    save(root);
    return doc.toString();
}

References save().

stringProperty()

QString KoProperties::stringProperty	(	const QString &	name,
		const QString &	defaultValue = QString() ) const

Return an QString property by name. A typical usage:

KoProperties *props = new KoProperties();
props->setProperty("name", "Marcy");
QString name = props->stringProperty("name");

Returns

an QString property by name

Parameters

name	the name (or key) with which the variant was registered.

See also

property() intProperty()

Parameters

defaultValue

the default value, should there not be any property by the name this will be returned.

Definition at line 163 of file KoProperties.cpp.

{
    const QVariant v = property(name);
    if (v.isValid())
        return v.toString();
    else
        return def;
}

References property(), and v.

value()

QVariant KoProperties::value

(

const QString &

key

)

const

Returns the value associated with the specified key if this properties object contains the specified key; otherwise return an empty QVariant.

Definition at line 177 of file KoProperties.cpp.

{
    return d->properties.value(key);
}

References d.

Member Data Documentation

d

Private* const KoProperties::d

private

Definition at line 168 of file KoProperties.h.

properties

QMap<QString, QVariant> KoProperties::properties

Definition at line 17 of file KoProperties.cpp.

---

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

• libs/widgetutils/KoProperties.cpp
• libs/widgetutils/KoProperties.h