KisPropertiesConfiguration Class Reference

#include <kis_properties_configuration.h>

Inheritance diagram for KisPropertiesConfiguration:

Public Member Functions
void	clearProperties ()
	Clear the map of properties.
virtual bool	compareTo (const KisPropertiesConfiguration *rhs) const
virtual void	dump () const
void	fromXML (const QDomElement &) override
bool	fromXML (const QString &xml, bool clear=true) override
bool	getBool (const QString &name, bool def=false) const
KoColor	getColor (const QString &name, const KoColor &color=KoColor()) const
	getColor fetch the given property as a KoColor.
KisCubicCurve	getCubicCurve (const QString &name, const KisCubicCurve &curve=KisCubicCurve()) const
double	getDouble (const QString &name, double def=0.0) const
float	getFloat (const QString &name, float def=0.0) const
int	getInt (const QString &name, int def=0) const
void	getPrefixedProperties (const QString &prefix, KisPropertiesConfiguration *config) const
void	getPrefixedProperties (const QString &prefix, KisPropertiesConfigurationSP config) const
virtual QMap< QString, QVariant >	getProperties () const
virtual QList< QString >	getPropertiesKeys () const
virtual QVariant	getProperty (const QString &name) const
virtual bool	getProperty (const QString &name, QVariant &value) const
QString	getPropertyLazy (const QString &name, const char *defaultValue) const
QStringList	getPropertyLazy (const QString &name, const QStringList &defaultValue) const
template<typename T >
T	getPropertyLazy (const QString &name, const T &defaultValue) const
QString	getString (const QString &name, const QString &def=QString()) const
QStringList	getStringList (const QString &name, const QStringList &defaultValue=QStringList()) const
virtual bool	hasProperty (const QString &name) const
	KisPropertiesConfiguration ()
	KisPropertiesConfiguration (const KisPropertiesConfiguration &rhs)
KisPropertiesConfiguration &	operator= (const KisPropertiesConfiguration &rhs)
void	removeProperty (const QString &name)
void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfiguration *config)
void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfigurationSP config)
void	setProperty (const QString &name, const QStringList &value)
virtual void	setProperty (const QString &name, const QVariant &value)
void	setPropertyNotSaved (const QString &name)
	Marks a property that should not be saved by toXML.
QString	toXML () const override
void	toXML (QDomDocument &, QDomElement &) const override
	~KisPropertiesConfiguration () override
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KisSerializableConfiguration
	KisSerializableConfiguration ()
	KisSerializableConfiguration (const KisSerializableConfiguration &rhs)
virtual	~KisSerializableConfiguration ()
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static QString	escapeString (const QString &string)
static QString	extractedPrefixKey ()
static QString	unescapeString (const QString &string)

Public Attributes
QSet< QString >	notSavedProperties
QMap< QString, QVariant >	properties
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Attributes
Private *const	d

Additional Inherited Members
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

KisPropertiesConfiguration is a map-based properties class that can be serialized and deserialized.

It differs from the base class KisSerializableConfiguration in that it provides a number of convenience methods to get at the data and

Definition at line 26 of file kis_properties_configuration.cc.

Constructor & Destructor Documentation

KisPropertiesConfiguration() [1/2]

KisPropertiesConfiguration::KisPropertiesConfiguration

(

)

Create a new properties config.

Definition at line 31 of file kis_properties_configuration.cc.

                                                       : d(new Private)
{
}

~KisPropertiesConfiguration()

KisPropertiesConfiguration::~KisPropertiesConfiguration ( )

override

Definition at line 35 of file kis_properties_configuration.cc.

{
    delete d;
}

References d.

KisPropertiesConfiguration() [2/2]

KisPropertiesConfiguration::KisPropertiesConfiguration

(

const KisPropertiesConfiguration &

rhs

)

Deep copy the properties rhs

Definition at line 40 of file kis_properties_configuration.cc.

    : KisSerializableConfiguration(rhs)
    , d(new Private(*rhs.d))
{
}

Member Function Documentation

clearProperties()

void KisPropertiesConfiguration::clearProperties

(

)

Clear the map of properties.

Definition at line 301 of file kis_properties_configuration.cc.

{
    d->properties.clear();
}

References d.

compareTo()

bool KisPropertiesConfiguration::compareTo ( const KisPropertiesConfiguration * rhs ) const

virtual

Structural comparison between two instances.

Reimplemented in KisFilterConfiguration, KisCrossChannelFilterConfiguration, and KisMultiChannelFilterConfiguration.

Definition at line 434 of file kis_properties_configuration.cc.

{
    if (rhs == nullptr)
        return false;
 
    for(const auto& propertyName: getPropertiesKeys()) {
        if (getProperty(propertyName) != rhs->getProperty(propertyName))
            return false;
    }
 
    return true;
}

References getPropertiesKeys(), and getProperty().

dump()

void KisPropertiesConfiguration::dump ( ) const

virtual

Reimplemented in KisLockedPropertiesProxy.

Definition at line 282 of file kis_properties_configuration.cc.

{
    QMap<QString, QVariant>::ConstIterator it;
    for (it = d->properties.constBegin(); it != d->properties.constEnd(); ++it) {
        if (it->type() == QVariant::ByteArray) {
            QByteArray ba = it->toByteArray();
 
            if (ba.size() > 32) {
                qDebug() << it.key() << " = " << QString("...skipped total %1 bytes...").arg(ba.size()) << it.value().typeName();
            } else {
                qDebug() << it.key() << " = " << it.value() << it.value().typeName();
            }
        } else {
            qDebug() << it.key() << " = " << it.value() << it.value().typeName();
        }
    }
 
}

References d.

escapeString()

QString KisPropertiesConfiguration::escapeString ( const QString & string )

static

Definition at line 373 of file kis_properties_configuration.cc.

{
    QString result = string;
    result.replace(";", "\\;");
    result.replace("]", "\\]");
    result.replace(">", "\\>");
    return result;
}

extractedPrefixKey()

QString KisPropertiesConfiguration::extractedPrefixKey ( )

static

After calling getPropertiesConfiguration() the resulting properties will contain the prefix they were packed with. The prefix can be requested with the key returned by extractedPrefixKey() function.

Definition at line 367 of file kis_properties_configuration.cc.

{
    static const QString key = "__extractedFromPrefix";
    return key;
}

fromXML() [1/2]

void KisPropertiesConfiguration::fromXML ( const QDomElement & root )

overridevirtual

Fill the properties configuration object from the XML encoded representation in s. This function use the "Legacy" style XML of the 1.x .kra file format.

Note: the existing properties will not be cleared

Implements KisSerializableConfiguration.

Definition at line 70 of file kis_properties_configuration.cc.

{
    QDomElement e;
    for (e = root.firstChildElement("param"); !e.isNull(); e = e.nextSiblingElement("param")) {
        QString name = e.attribute("name");
        QString value = e.text();
 
        // Older versions didn't have a "type" parameter,
        // so fall back to the old behavior if it's missing.
        if (!e.hasAttribute("type")) {
            d->properties[name] = QVariant(value);
        } else if (e.attribute("type") == "bytearray") {
            d->properties[name] = QVariant(QByteArray::fromBase64(value.toLatin1()));
        } else {
            d->properties[name] = value;
        }
    }
}

fromXML() [2/2]

bool KisPropertiesConfiguration::fromXML ( const QString & xml, bool clear = true )

overridevirtual

Fill the properties configuration object from the XML encoded representation in s. This function use the "Legacy" style XML of the 1.x .kra file format.

Parameters

xml	the string that will be parsed as xml
clear	if true, the properties map will be emptied.

Returns

true is the xml document could be parsed

Reimplemented from KisSerializableConfiguration.

Definition at line 55 of file kis_properties_configuration.cc.

{
    if (clear) {
        clearProperties();
    }
 
    QDomDocument doc;
    bool retval = bool(doc.setContent(xml));
    if (retval) {
        QDomElement e = doc.documentElement();
        fromXML(e);
    }
    return retval;
}

References clearProperties().

getBool()

bool KisPropertiesConfiguration::getBool	(	const QString &	name,
		bool	def = false ) const

Definition at line 196 of file kis_properties_configuration.cc.

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

References getProperty(), and v.

getColor()

KoColor KisPropertiesConfiguration::getColor	(	const QString &	name,
		const KoColor &	color = KoColor() ) const

getColor fetch the given property as a KoColor.

The color can be stored as

• A KoColor
• A QColor
• A string that can be parsed as an XML color definition
• A string that QColor can convert to a color (see https://doc.qt.io/qt-5/qcolor.html#setNamedColor)
• An integer that QColor can convert to a color

Parameters

name	the name of the property
color	the default value to be returned if the
name	does not exist.

Returns

returns the named property as a KoColor if the value can be converted to a color, otherwise a empty KoColor is returned.

Definition at line 227 of file kis_properties_configuration.cc.

{
    QVariant v = getProperty(name);
 
    if (v.isValid()) {
        switch(v.type()) {
        case QVariant::UserType:
        {
            if (v.userType() == qMetaTypeId<KoColor>()) {
                return v.value<KoColor>();
            }
            break;
        }
        case QVariant::String:
        {
            QDomDocument doc;
            if (doc.setContent(v.toString())) {
                QDomElement e = doc.documentElement().firstChild().toElement();
                bool ok;
                KoColor c = KoColor::fromXML(e, Integer16BitsColorDepthID.id(), &ok);
                if (ok) {
                    return c;
                }
            }
            else {
                QColor c(v.toString());
                if (c.isValid()) {
                    KoColor kc(c, KoColorSpaceRegistry::instance()->rgb8());
                    return kc;
                }
            }
            break;
        }
        case QVariant::Color:
        {
            QColor c = v.value<QColor>();
            KoColor kc(c, KoColorSpaceRegistry::instance()->rgb8());
            return kc;
        }
        case QVariant::Int:
        {
            QColor c(v.toInt());
            if (c.isValid()) {
                KoColor kc(c, KoColorSpaceRegistry::instance()->rgb8());
                return kc;
            }
            break;
        }
        default:
            ;
        }
    }
    return color;
}

References KoColor::fromXML(), getProperty(), KoID::id(), KoColorSpaceRegistry::instance(), Integer16BitsColorDepthID, and v.

getCubicCurve()

KisCubicCurve KisPropertiesConfiguration::getCubicCurve	(	const QString &	name,
		const KisCubicCurve &	curve = KisCubicCurve() ) const

Definition at line 214 of file kis_properties_configuration.cc.

{
    QVariant v = getProperty(name);
    if (v.isValid()) {
        if (v.type() == QVariant::UserType && v.userType() == qMetaTypeId<KisCubicCurve>()) {
            return v.value<KisCubicCurve>();
        } else {
            return KisCubicCurve(v.toString());
        }
    } else
        return curve;
}

References getProperty(), and v.

getDouble()

double KisPropertiesConfiguration::getDouble	(	const QString &	name,
		double	def = 0.0 ) const

Definition at line 177 of file kis_properties_configuration.cc.

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

References getProperty(), and v.

getFloat()

float KisPropertiesConfiguration::getFloat	(	const QString &	name,
		float	def = 0.0 ) const

Definition at line 186 of file kis_properties_configuration.cc.

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

References getProperty(), and v.

getInt()

int KisPropertiesConfiguration::getInt	(	const QString &	name,
		int	def = 0 ) const

Definition at line 167 of file kis_properties_configuration.cc.

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

References getProperty(), and v.

getPrefixedProperties() [1/2]

void KisPropertiesConfiguration::getPrefixedProperties	(	const QString &	prefix,
		KisPropertiesConfiguration *	config ) const

Get a set of properties, which keys are prefixed with prefix. The settings object config will have all these properties with the prefix stripped from them.

Definition at line 326 of file kis_properties_configuration.cc.

{
    const int prefixSize = prefix.size();
 
    const QList<QString> keys = getPropertiesKeys();
    Q_FOREACH (const QString &key, keys) {
        if (key.startsWith(prefix)) {
            config->setProperty(key.mid(prefixSize), getProperty(key));
        }
    }
 
    QString fullPrefix;
    const QString parentPrefix = getString(extractedPrefixKey());
    if (!parentPrefix.isEmpty()) {
        fullPrefix = parentPrefix + "/" + prefix;
    } else {
        fullPrefix = prefix;
    }
 
    config->setProperty(extractedPrefixKey(), fullPrefix);
    config->setPropertyNotSaved(extractedPrefixKey());
}

References extractedPrefixKey(), getPropertiesKeys(), getProperty(), getString(), setProperty(), and setPropertyNotSaved().

getPrefixedProperties() [2/2]

void KisPropertiesConfiguration::getPrefixedProperties	(	const QString &	prefix,
		KisPropertiesConfigurationSP	config ) const

A convenience override

Definition at line 349 of file kis_properties_configuration.cc.

{
    getPrefixedProperties(prefix, config.data());
}

References KisSharedPtr< T >::data(), and getPrefixedProperties().

getProperties()

QMap< QString, QVariant > KisPropertiesConfiguration::getProperties ( ) const

virtual

Definition at line 311 of file kis_properties_configuration.cc.

{
    return d->properties;
}

References d.

getPropertiesKeys()

QList< QString > KisPropertiesConfiguration::getPropertiesKeys ( ) const

virtual

Get the keys of all the properties in the object

Reimplemented in KisLockedPropertiesProxy.

Definition at line 321 of file kis_properties_configuration.cc.

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

References d.

getProperty() [1/2]

QVariant KisPropertiesConfiguration::getProperty ( const QString & name ) const

virtual

Reimplemented in KisLockedPropertiesProxy, and KisLockedPropertiesProxy.

Definition at line 161 of file kis_properties_configuration.cc.

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

References d.

getProperty() [2/2]

bool KisPropertiesConfiguration::getProperty ( const QString & name, QVariant & value ) const

virtual

Set value to the value associated with property name

XXX: API alert: a setter that is prefixed with get?

Returns

false if the specified property did not exist.

Reimplemented in KisLockedPropertiesProxy.

Definition at line 151 of file kis_properties_configuration.cc.

{
    if (d->properties.constFind(name) == d->properties.constEnd()) {
        return false;
    } else {
        value = d->properties.value(name);
        return true;
    }
}

References d, and value().

getPropertyLazy() [1/3]

QString KisPropertiesConfiguration::getPropertyLazy ( const QString & name, const char * defaultValue ) const

inline

Definition at line 111 of file kis_properties_configuration.h.

                                                                                  {
        return getPropertyLazy(name, QString(defaultValue));
    }

getPropertyLazy() [2/3]

QStringList KisPropertiesConfiguration::getPropertyLazy	(	const QString &	name,
		const QStringList &	defaultValue ) const

Definition at line 429 of file kis_properties_configuration.cc.

{
    return getStringList(name, defaultValue);
}

References getStringList().

getPropertyLazy() [3/3]

template<typename T >

T KisPropertiesConfiguration::getPropertyLazy ( const QString & name, const T & defaultValue ) const

inline

Definition at line 106 of file kis_properties_configuration.h.

                                                                             {
        QVariant value = getProperty(name);
        return value.isValid() ? value.value<T>() : defaultValue;
    }

References value().

getString()

QString KisPropertiesConfiguration::getString	(	const QString &	name,
		const QString &	def = QString() ) const

Definition at line 205 of file kis_properties_configuration.cc.

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

References getProperty(), and v.

getStringList()

QStringList KisPropertiesConfiguration::getStringList	(	const QString &	name,
		const QStringList &	defaultValue = QStringList() ) const

Definition at line 403 of file kis_properties_configuration.cc.

{
    if (!hasProperty(name)) return defaultValue;
 
    const QString joined = getString(name);
 
    QStringList result;
 
    int afterLastMatch = -1;
    for (int i = 0; i < joined.size(); i++) {
        const bool lastChunk = i == joined.size() - 1;
        const bool matchedSplitter = joined[i] == ';' && (i == 0 || joined[i - 1] != '\\');
 
        if (lastChunk || matchedSplitter) {
            result << unescapeString(joined.mid(afterLastMatch, i - afterLastMatch + int(lastChunk && !matchedSplitter)));
            afterLastMatch = i + 1;
        }
 
        if (lastChunk && matchedSplitter) {
            result << QString();
        }
    }
 
    return result;
}

References getString(), hasProperty(), and unescapeString().

hasProperty()

bool KisPropertiesConfiguration::hasProperty ( const QString & name ) const

virtual

Returns

true if the map contains a property with the specified name

Reimplemented in KisLockedPropertiesProxy.

Definition at line 137 of file kis_properties_configuration.cc.

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

References d.

operator=()

KisPropertiesConfiguration & KisPropertiesConfiguration::operator=

(

const KisPropertiesConfiguration &

rhs

)

Deep copy the properties rhs

Definition at line 46 of file kis_properties_configuration.cc.

{
    if (&rhs != this) {
        *d = *rhs.d;
    }
 
    return *this;
}

References d.

removeProperty()

void KisPropertiesConfiguration::removeProperty

(

const QString &

name

)

Definition at line 316 of file kis_properties_configuration.cc.

{
    d->properties.remove(name);
}

References d.

setPrefixedProperties() [1/2]

void KisPropertiesConfiguration::setPrefixedProperties	(	const QString &	prefix,
		const KisPropertiesConfiguration *	config )

Takes all the properties from config, adds prefix to all their keys and puts them into this properties object

Definition at line 354 of file kis_properties_configuration.cc.

{
    const QList<QString> keys = config->getPropertiesKeys();
    Q_FOREACH (const QString &key, keys) {
        this->setProperty(prefix + key, config->getProperty(key));
    }
}

References getPropertiesKeys(), getProperty(), and setProperty().

setPrefixedProperties() [2/2]

void KisPropertiesConfiguration::setPrefixedProperties	(	const QString &	prefix,
		const KisPropertiesConfigurationSP	config )

A convenience override

Definition at line 362 of file kis_properties_configuration.cc.

{
    setPrefixedProperties(prefix, config.data());
}

References KisSharedPtr< T >::data(), and setPrefixedProperties().

setProperty() [1/2]

void KisPropertiesConfiguration::setProperty	(	const QString &	name,
		const QStringList &	value )

Definition at line 391 of file kis_properties_configuration.cc.

{
    QStringList escapedList;
    escapedList.reserve(value.size());
 
    Q_FOREACH (const QString &str, value) {
        escapedList << escapeString(str);
    }
 
    setProperty(name, escapedList.join(';'));
}

References escapeString(), setProperty(), and value().

setProperty() [2/2]

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

virtual

Set the property with name to value.

Reimplemented in KisLockedPropertiesProxy, KisLockedPropertiesProxy, KisPaintOpSettings, KisColorTransformationConfiguration, KisCrossChannelFilterConfiguration, KisMultiChannelFilterConfiguration, KisHalftoneFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 142 of file kis_properties_configuration.cc.

{
    if (d->properties.find(name) == d->properties.end()) {
        d->properties.insert(name, value);
    } else {
        d->properties[name] = value;
    }
}

References d, and value().

setPropertyNotSaved()

void KisPropertiesConfiguration::setPropertyNotSaved

(

const QString &

name

)

Marks a property that should not be saved by toXML.

Definition at line 306 of file kis_properties_configuration.cc.

{
    d->notSavedProperties.insert(name);
}

References d.

toXML() [1/2]

QString KisPropertiesConfiguration::toXML ( ) const

overridevirtual

Create a serialized version of this properties config This function use the "Legacy" style XML of the 1.x .kra file format.

Reimplemented from KisSerializableConfiguration.

Definition at line 127 of file kis_properties_configuration.cc.

{
    QDomDocument doc = QDomDocument("params");
    QDomElement root = doc.createElement("params");
    doc.appendChild(root);
    toXML(doc, root);
    return doc.toString();
}

References toXML().

toXML() [2/2]

void KisPropertiesConfiguration::toXML ( QDomDocument & doc, QDomElement & root ) const

overridevirtual

Create a serialized version of this properties config This function use the "Legacy" style XML of the 1.x .kra file format.

Implements KisSerializableConfiguration.

Definition at line 89 of file kis_properties_configuration.cc.

{
    QMap<QString, QVariant>::ConstIterator it;
    for (it = d->properties.constBegin(); it != d->properties.constEnd(); ++it) {
        if (d->notSavedProperties.contains(it.key())) {
            continue;
        }
 
        QDomElement e = doc.createElement("param");
        e.setAttribute("name", QString(it.key().toLatin1()));
        QString type = "string";
        QVariant v = it.value();
        QDomText text;
        if (v.type() == QVariant::UserType && v.userType() == qMetaTypeId<KisCubicCurve>()) {
            text = doc.createCDATASection(v.value<KisCubicCurve>().toString());
        } else if (v.type() == QVariant::UserType && v.userType() == qMetaTypeId<KoColor>()) {
            QDomDocument cdataDoc = QDomDocument("color");
            QDomElement cdataRoot = cdataDoc.createElement("color");
            cdataDoc.appendChild(cdataRoot);
            v.value<KoColor>().toXML(cdataDoc, cdataRoot);
            text = cdataDoc.createCDATASection(cdataDoc.toString());
            type = "color";
        } else if(v.type() == QVariant::String ) {
            text = doc.createCDATASection(v.toString());  // XXX: Unittest this!
            type = "string";
        } else if(v.type() == QVariant::ByteArray ) {
            text = doc.createTextNode(QString::fromLatin1(v.toByteArray().toBase64())); // Arbitrary Data
            type = "bytearray";
        } else {
            text = doc.createTextNode(v.toString());
            type = "internal";
        }
        e.setAttribute("type", type);
        e.appendChild(text);
        root.appendChild(e);
    }
}

unescapeString()

QString KisPropertiesConfiguration::unescapeString ( const QString & string )

static

Definition at line 382 of file kis_properties_configuration.cc.

{
    QString result = string;
    result.replace("\\;", ";");
    result.replace("\\]", "]");
    result.replace("\\>", ">");
    return result;
}

Member Data Documentation

d

Private* const KisPropertiesConfiguration::d

private

Definition at line 209 of file kis_properties_configuration.h.

notSavedProperties

QSet<QString> KisPropertiesConfiguration::notSavedProperties

Definition at line 28 of file kis_properties_configuration.cc.

properties

QMap<QString, QVariant> KisPropertiesConfiguration::properties

Definition at line 27 of file kis_properties_configuration.cc.

---

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

• libs/image/kis_properties_configuration.cc
• libs/image/kis_properties_configuration.h