#include <kis_locked_properties_proxy.h>

Inheritance diagram for KisLockedPropertiesProxy:

Public Member Functions
void	dump () const override

QList< QString >	getPropertiesKeys () const override

virtual QVariant	getProperty (const QString &name) const

QVariant	getProperty (const QString &name) const override

virtual bool	getProperty (const QString &name, QVariant &value) const

bool	hasProperty (const QString &name) const override

	KisLockedPropertiesProxy (KisPropertiesConfiguration *, KisLockedPropertiesSP)

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

virtual void	setProperty (const QString &name, const QVariant &value)

void	setProperty (const QString &name, const QVariant &value) override

	~KisLockedPropertiesProxy () override

Public Member Functions inherited from KisPropertiesConfiguration
void	clearProperties ()
	Clear the map of properties.

virtual bool	compareTo (const KisPropertiesConfiguration *rhs) 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

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

	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)

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 ()

Private Attributes
KisLockedPropertiesSP	m_lockedProperties

KisPropertiesConfiguration *	m_parent

Additional Inherited Members
Static Public Member Functions inherited from KisPropertiesConfiguration
static QString	escapeString (const QString &string)

static QString	extractedPrefixKey ()

static QString	unescapeString (const QString &string)

Public Attributes inherited from KisPropertiesConfiguration
QSet< QString >	notSavedProperties

QMap< QString, QVariant >	properties

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Detailed Description

Definition at line 26 of file kis_locked_properties_proxy.h.

Constructor & Destructor Documentation

◆ KisLockedPropertiesProxy()

KisLockedPropertiesProxy::KisLockedPropertiesProxy	(	KisPropertiesConfiguration *	p,
		KisLockedPropertiesSP	l )

Definition at line 18 of file kis_locked_properties_proxy.cpp.

{
    m_parent = p;
    m_lockedProperties = l;
}

References m_lockedProperties, m_parent, and p.

◆ ~KisLockedPropertiesProxy()

KisLockedPropertiesProxy::~KisLockedPropertiesProxy ( )

override

Definition at line 24 of file kis_locked_properties_proxy.cpp.

25{

26}

Member Function Documentation

◆ dump()

void KisLockedPropertiesProxy::dump ( ) const

overridevirtual

Reimplemented from KisPropertiesConfiguration.

Definition at line 121 of file kis_locked_properties_proxy.cpp.

{
    qDebug() << "=== KisLockedPropertiesProxy::dump() ===";
    qDebug() << "parent properties:";
    m_parent->dump();
 
    if (m_lockedProperties->lockedProperties()) {
        qDebug() << "locked properties:";
        m_lockedProperties->lockedProperties()->dump();
    }
}

References KisPropertiesConfiguration::dump(), KisLockedProperties::lockedProperties(), m_lockedProperties, and m_parent.

◆ getPropertiesKeys()

QList< QString > KisLockedPropertiesProxy::getPropertiesKeys ( ) const

overridevirtual

Get the keys of all the properties in the object

Reimplemented from KisPropertiesConfiguration.

Definition at line 102 of file kis_locked_properties_proxy.cpp.

{
    KisPaintOpSettings *t = dynamic_cast<KisPaintOpSettings*>(m_parent);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(t, m_parent->getPropertiesKeys());
    if (!t->updateListener()) return m_parent->getPropertiesKeys();
 
    QList<QString> result = m_parent->getPropertiesKeys();
 
    if (m_lockedProperties->lockedProperties() && !m_lockedProperties->lockedProperties()->getPropertiesKeys().isEmpty()) {
        QSet<QString> properties(result.begin(), result.end());
        auto lockedPropertiesKeys = m_lockedProperties->lockedProperties()->getPropertiesKeys();
        QSet<QString> lockedProperties(lockedPropertiesKeys.begin(), lockedPropertiesKeys.end());
        properties += lockedProperties;
        result = QList<QString>(properties.begin(), properties.end()) ;
    }
 
    return result;
}

References KisPropertiesConfiguration::getPropertiesKeys(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisLockedProperties::lockedProperties(), m_lockedProperties, m_parent, KisPropertiesConfiguration::properties, and KisPaintOpSettings::updateListener.

◆ getProperty() [1/3]

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

virtual

Reimplemented from KisPropertiesConfiguration.

Definition at line 103 of file kis_properties_configuration.cc.

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

◆ getProperty() [2/3]

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

overridevirtual

Reimplemented from KisPropertiesConfiguration.

Definition at line 28 of file kis_locked_properties_proxy.cpp.

{
    KisPaintOpSettings *t = dynamic_cast<KisPaintOpSettings*>(m_parent);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(t, m_parent->getProperty(name));
    if (!t->updateListener()) return m_parent->getProperty(name);
 
    // restores the dirty state on returns automagically
    KisPaintOpSettings::UpdateListenerSP updateProxy = t->updateListener().toStrongRef();
    KisDirtyStateSaver<KisPaintOpSettings::UpdateListenerSP> dirtyStateSaver(updateProxy);
 
    if (m_lockedProperties->lockedProperties()) {
        if (m_lockedProperties->lockedProperties()->hasProperty(name)) {
            KisLockedPropertiesServer::instance()->setPropertiesFromLocked(true);
 
            if (!m_parent->hasProperty(name + "_previous")) {
                m_parent->setProperty(name + "_previous", m_parent->getProperty(name));
                m_parent->setPropertyNotSaved(name + "_previous");
            }
 
            const QVariant lockedProp = m_lockedProperties->lockedProperties()->getProperty(name);
 
            if (m_parent->getProperty(name) != lockedProp) {
                m_parent->setProperty(name, lockedProp);
            }
 
            return lockedProp;
        } else {
            if (m_parent->hasProperty(name + "_previous")) {
                m_parent->setProperty(name, m_parent->getProperty(name + "_previous"));
                m_parent->removeProperty(name + "_previous");
            }
        }
    }
 
    return m_parent->getProperty(name);
}

References KisPropertiesConfiguration::getProperty(), KisPropertiesConfiguration::hasProperty(), KisLockedPropertiesServer::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisLockedProperties::lockedProperties(), m_lockedProperties, m_parent, KisPropertiesConfiguration::removeProperty(), KisLockedPropertiesServer::setPropertiesFromLocked(), KisPropertiesConfiguration::setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), and KisPaintOpSettings::updateListener.

◆ getProperty() [3/3]

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 from KisPropertiesConfiguration.

Definition at line 101 of file kis_properties_configuration.cc.

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

◆ hasProperty()

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

overridevirtual

Returns: true if the map contains a property with the specified name

Reimplemented from KisPropertiesConfiguration.

Definition at line 90 of file kis_locked_properties_proxy.cpp.

{
    KisPaintOpSettings *t = dynamic_cast<KisPaintOpSettings*>(m_parent);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(t, m_parent->hasProperty(name));
    if (!t->updateListener()) return m_parent->hasProperty(name);
 
    return (m_lockedProperties->lockedProperties() &&
            m_lockedProperties->lockedProperties()->hasProperty(name)) ||
            m_parent->hasProperty(name);
 
}

References KisPropertiesConfiguration::hasProperty(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisLockedProperties::lockedProperties(), m_lockedProperties, m_parent, and KisPaintOpSettings::updateListener.

◆ setProperty() [1/3]

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

Definition at line 193 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(';'));
}

◆ setProperty() [2/3]

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

virtual

Set the property with name to value.

Reimplemented from KisPropertiesConfiguration.

Definition at line 92 of file kis_properties_configuration.cc.

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

◆ setProperty() [3/3]

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

overridevirtual

Set the property with name to value.

Reimplemented from KisPropertiesConfiguration.

Definition at line 65 of file kis_locked_properties_proxy.cpp.

{
    KisPaintOpSettings *t = dynamic_cast<KisPaintOpSettings*>(m_parent);
    KIS_SAFE_ASSERT_RECOVER_RETURN(t);
    if (!t->updateListener()) return;
 
    if (m_lockedProperties->lockedProperties()) {
        if (m_lockedProperties->lockedProperties()->hasProperty(name)) {
            m_lockedProperties->lockedProperties()->setProperty(name, value);
            m_parent->setProperty(name, value);
 
            if (!m_parent->hasProperty(name + "_previous")) {
                // restores the dirty state on returns automagically
                KisPaintOpSettings::UpdateListenerSP updateProxy = t->updateListener().toStrongRef();
                KisDirtyStateSaver<KisPaintOpSettings::UpdateListenerSP> dirtyStateSaver(updateProxy);
                m_parent->setProperty(name + "_previous", m_parent->getProperty(name));
                m_parent->setPropertyNotSaved(name + "_previous");
            }
            return;
        }
    }
 
    m_parent->setProperty(name, value);
}

References KisPropertiesConfiguration::getProperty(), KisPropertiesConfiguration::hasProperty(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisLockedProperties::lockedProperties(), m_lockedProperties, m_parent, KisPropertiesConfiguration::setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), KisPaintOpSettings::updateListener, and value().

Member Data Documentation

◆ m_lockedProperties

KisLockedPropertiesSP KisLockedPropertiesProxy::m_lockedProperties

mutableprivate

Definition at line 45 of file kis_locked_properties_proxy.h.

◆ m_parent

KisPropertiesConfiguration* KisLockedPropertiesProxy::m_parent

private

Definition at line 46 of file kis_locked_properties_proxy.h.

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

libs/image/brushengine/kis_locked_properties_proxy.h
libs/image/brushengine/kis_locked_properties_proxy.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisLockedPropertiesProxy()

◆ ~KisLockedPropertiesProxy()

Member Function Documentation

◆ dump()

◆ getPropertiesKeys()

◆ getProperty() [1/3]

◆ getProperty() [2/3]

◆ getProperty() [3/3]

◆ hasProperty()

◆ setProperty() [1/3]

◆ setProperty() [2/3]

◆ setProperty() [3/3]

Member Data Documentation

◆ m_lockedProperties

◆ m_parent