Référence de la classe KoProperties

#include <KoProperties.h>

Liste de tous les membres

Fonctions membres publiques

 KoProperties ()
 KoProperties (const KoProperties &rhs)
virtual ~KoProperties ()
virtual void load (const QString &)
virtual QString store ()
virtual void setProperty (const QString &name, const QVariant &value)
virtual bool getProperty (const QString &name, QVariant &value) const
virtual QVariant getProperty (const QString &name) const
int getInt (const QString &name, int def=0) const
double getDouble (const QString &name, double def=0.0) const
bool getBool (const QString &name, bool def=false) const
QString getString (const QString &name, const QString &def=QString::null) const

Attributs protégés

QMap< QString, QVariant > m_properties

Fonctions membres privées

void dump ()

Description détaillée

A KoProperties 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.

Définition à la ligne 34 du fichier KoProperties.h.

Documentation des contructeurs et destructeur

KoProperties::KoProperties (  )  [inline]

Create a new filter config.

Définition à la ligne 41 du fichier KoProperties.h.

KoProperties::KoProperties ( const KoProperties &  rhs  ) 

Deep copy the filter configFile

Définition à la ligne 25 du fichier KoProperties.cpp.

virtual KoProperties::~KoProperties (  )  [inline, virtual]

Définition à la ligne 48 du fichier KoProperties.h.

Documentation des fonctions membres

void KoProperties::load ( const QString &   )  [virtual]

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

Définition à la ligne 30 du fichier KoProperties.cpp.

Références m_properties, KoPageFormat::name(), Py::type(), et Py::value().

Voici le graphe d'appel pour cette fonction :

QString KoProperties::store (  )  [virtual]

Create a serialized version of this filter config

Définition à la ligne 55 du fichier KoProperties.cpp.

Références m_properties.

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

Set the property with name to value.

Définition à la ligne 78 du fichier KoProperties.cpp.

Références m_properties.

Référencé par KoTextShapeFactory::KoTextShapeFactory().

Voici le graphe d'appel pour cette fonction :

bool KoProperties::getProperty ( const QString &  name,
QVariant &  value 
) const [virtual]

Set value to the value associated with property name

Renvoie:
false if the specified property did not exist.

Définition à la ligne 84 du fichier KoProperties.cpp.

Références m_properties.

Référencé par KoTextShapeFactory::createShape(), getBool(), getDouble(), getInt(), et getString().

Voici le graphe d'appel pour cette fonction :

QVariant KoProperties::getProperty ( const QString &  name  )  const [virtual]

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->getProperty("name").toString();
      int age = props->getProperty("age").toInt();
Renvoie:
a property by name, wrapped in a QVariant.
Paramètres:
name the name (or key) with which the variant was registered.
Voir également:
getInt() getString()

Définition à la ligne 96 du fichier KoProperties.cpp.

Références m_properties.

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

Return an integer property by name. A typical usage: 

      KoProperties *props = new KoProperties();
      props->setProperty("age", 25);
      int age = props->getInt("age");
Renvoie:
an integer property by name
Paramètres:
name the name (or key) with which the variant was registered.
def the default value, should there not be any property by the name this will be returned.
Voir également:
getProperty() getString()

Définition à la ligne 102 du fichier KoProperties.cpp.

Références getProperty().

Voici le graphe d'appel pour cette fonction :

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

Return a double property by name.

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

Définition à la ligne 112 du fichier KoProperties.cpp.

Références getProperty().

Voici le graphe d'appel pour cette fonction :

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

Return a boolean property by name.

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

Définition à la ligne 121 du fichier KoProperties.cpp.

Références getProperty().

Voici le graphe d'appel pour cette fonction :

QString KoProperties::getString ( const QString &  name,
const QString &  def = QString::null 
) const

Return an QString property by name. A typical usage: 

      KoProperties *props = new KoProperties();
      props->setProperty("name", "Marcy");
      QString name = props->getString("name");
Renvoie:
an QString property by name
Paramètres:
name the name (or key) with which the variant was registered.
Voir également:
getProperty() getInt()
Paramètres:
def the default value, should there not be any property by the name this will be returned.

Définition à la ligne 130 du fichier KoProperties.cpp.

Références getProperty().

Voici le graphe d'appel pour cette fonction :

void KoProperties::dump (  )  [private]

Définition à la ligne 139 du fichier KoProperties.cpp.

Références m_properties.

Documentation des données membres

QMap<QString, QVariant> KoProperties::m_properties [protected]

Définition à la ligne 137 du fichier KoProperties.h.

Référencé par dump(), getProperty(), load(), setProperty(), et store().

La documentation de cette classe a été générée à partir des fichiers suivants :
Généré le Wed Nov 22 23:48:32 2006 pour KPlato par  doxygen 1.5.1-p1