krita
KisFilterConfiguration Class Reference
#include <kis_filter_configuration.h>
Detailed Description
A KisFilterConfiguration is the serializable representation of the filter parameters.Filters can subclass this class to implement direct accessors to properties, but properties not in the map will not be serialized.
Definition at line 38 of file kis_filter_configuration.h.
Public Member Functions | |
KisFilterConfiguration (const QString &name, Q_INT32 version) | |
KisFilterConfiguration (const KisFilterConfiguration &rhs) | |
virtual void | fromXML (const QString &) |
virtual QString | toString () |
const QString & | name () const |
Q_INT32 | version () const |
virtual void | setProperty (const QString &name, const QVariant &value) |
virtual bool | getProperty (const QString &name, QVariant &value) |
virtual QVariant | getProperty (const QString &name) |
int | getInt (const QString &name, int def=0) |
double | getDouble (const QString &name, double def=0.0) |
bool | getBool (const QString &name, bool def=false) |
QString | getString (const QString &name, QString def=QString::null) |
Protected Attributes | |
QString | m_name |
Q_INT32 | m_version |
QMap< QString, QVariant > | m_properties |
Constructor & Destructor Documentation
KisFilterConfiguration::KisFilterConfiguration | ( | const QString & | name, | |
Q_INT32 | version | |||
) | [inline] |
KisFilterConfiguration::KisFilterConfiguration | ( | const KisFilterConfiguration & | rhs | ) |
Member Function Documentation
void KisFilterConfiguration::fromXML | ( | const QString & | ) | [virtual] |
Fill the filter configuration object from the XML encoded representation in s.
Definition at line 43 of file kis_filter_configuration.cc.
bool KisFilterConfiguration::getProperty | ( | const QString & | name, | |
QVariant & | value | |||
) | [virtual] |
Set value to the value associated with property name.
- Returns:
- false if the specified property did not exist.
Definition at line 120 of file kis_filter_configuration.cc.
const QString & KisFilterConfiguration::name | ( | ) | const |
Get the unique, language independent name of the filter.
Definition at line 100 of file kis_filter_configuration.cc.
void KisFilterConfiguration::setProperty | ( | const QString & | name, | |
const QVariant & | value | |||
) | [virtual] |
QString KisFilterConfiguration::toString | ( | ) | [virtual] |
Create a serialized version of this filter config.
Definition at line 76 of file kis_filter_configuration.cc.
Q_INT32 KisFilterConfiguration::version | ( | ) | const |
Get the version of the filter that has created this config.
Definition at line 105 of file kis_filter_configuration.cc.
The documentation for this class was generated from the following files: