chalk

Public Member Functions | Protected Attributes | List of all members
KisFilterConfiguration Class Reference

#include <kis_filter_configuration.h>

Public Member Functions

 KisFilterConfiguration (const TQString &name, TQ_INT32 version)
 
 KisFilterConfiguration (const KisFilterConfiguration &rhs)
 
virtual void fromXML (const TQString &)
 
virtual TQString toString ()
 
const TQString & name () const
 
TQ_INT32 version () const
 
virtual void setProperty (const TQString &name, const TQVariant &value)
 
virtual bool getProperty (const TQString &name, TQVariant &value)
 
virtual TQVariant getProperty (const TQString &name)
 
int getInt (const TQString &name, int def=0)
 
double getDouble (const TQString &name, double def=0.0)
 
bool getBool (const TQString &name, bool def=false)
 
TQString getString (const TQString &name, TQString def=TQString())
 

Protected Attributes

TQString m_name
 
TQ_INT32 m_version
 
TQStringVariantMap m_properties
 

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.

Constructor & Destructor Documentation

◆ KisFilterConfiguration() [1/2]

KisFilterConfiguration::KisFilterConfiguration ( const TQString &  name,
TQ_INT32  version 
)
inline

Create a new filter config.

Definition at line 45 of file kis_filter_configuration.h.

◆ KisFilterConfiguration() [2/2]

KisFilterConfiguration::KisFilterConfiguration ( const KisFilterConfiguration &  rhs)

Deep copy the filter configFile.

Definition at line 36 of file kis_filter_configuration.cpp.

Member Function Documentation

◆ fromXML()

void KisFilterConfiguration::fromXML ( const TQString &  s)
virtual

Fill the filter configuration object from the XML encoded representation in s.

Definition at line 43 of file kis_filter_configuration.cpp.

◆ getBool()

bool KisFilterConfiguration::getBool ( const TQString &  name,
bool  def = false 
)

Definition at line 161 of file kis_filter_configuration.cpp.

◆ getDouble()

double KisFilterConfiguration::getDouble ( const TQString &  name,
double  def = 0.0 
)

Definition at line 152 of file kis_filter_configuration.cpp.

◆ getInt()

int KisFilterConfiguration::getInt ( const TQString &  name,
int  def = 0 
)

Definition at line 142 of file kis_filter_configuration.cpp.

◆ getProperty() [1/2]

TQVariant KisFilterConfiguration::getProperty ( const TQString &  name)
virtual

Definition at line 131 of file kis_filter_configuration.cpp.

◆ getProperty() [2/2]

bool KisFilterConfiguration::getProperty ( const TQString &  name,
TQVariant &  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.cpp.

◆ getString()

TQString KisFilterConfiguration::getString ( const TQString &  name,
TQString  def = TQString() 
)

Definition at line 170 of file kis_filter_configuration.cpp.

◆ name()

const TQString & KisFilterConfiguration::name ( ) const

Get the unique, language independent name of the filter.

Definition at line 100 of file kis_filter_configuration.cpp.

◆ setProperty()

void KisFilterConfiguration::setProperty ( const TQString &  name,
const TQVariant &  value 
)
virtual

Set the property with name to value.

Definition at line 110 of file kis_filter_configuration.cpp.

◆ toString()

TQString KisFilterConfiguration::toString ( )
virtual

Create a serialized version of this filter config.

Definition at line 76 of file kis_filter_configuration.cpp.

◆ version()

TQ_INT32 KisFilterConfiguration::version ( ) const

Get the version of the filter that has created this config.

Definition at line 105 of file kis_filter_configuration.cpp.

Member Data Documentation

◆ m_name

TQString KisFilterConfiguration::m_name
protected

Definition at line 99 of file kis_filter_configuration.h.

◆ m_properties

TQStringVariantMap KisFilterConfiguration::m_properties
protected

Definition at line 101 of file kis_filter_configuration.h.

◆ m_version

TQ_INT32 KisFilterConfiguration::m_version
protected

Definition at line 100 of file kis_filter_configuration.h.

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