Kopete::PropertyContainer Class Reference

#include <kopetepropertycontainer.h>

Inheritance diagram for Kopete::PropertyContainer:

Signals
void	propertyChanged (Kopete::PropertyContainer *container, const QString &key, const QVariant &oldValue, const QVariant &newValue)

Public Member Functions
	PropertyContainer (QObject *parent=0)
virtual	~PropertyContainer ()
void	deserializeProperties (const QMap< QString, QString > &serializedData)
bool	hasProperty (const QString &key) const
QStringList	properties () const
const Kopete::Property &	property (const QString &key) const
const Kopete::Property &	property (const Kopete::PropertyTmpl &tmpl) const
void	removeProperty (const Kopete::PropertyTmpl &tmpl)
void	serializeProperties (QMap< QString, QString > &serializedData) const
void	setProperty (const Kopete::PropertyTmpl &tmpl, const QVariant &value)

Detailed Description

Author

Gustavo Pichorim Boiko gusta.nosp@m.vo.b.nosp@m.oiko@.nosp@m.kdem.nosp@m.ail.n.nosp@m.et

This class abstracts a generic contact Use it for inserting contacts in the contact list for example.

Definition at line 39 of file kopetepropertycontainer.h.

Constructor & Destructor Documentation

Kopete::PropertyContainer::PropertyContainer

(

QObject *

parent = 0

)

A container for properties.

This class provides an interface for reading and writing properties.

Definition at line 36 of file kopetepropertycontainer.cpp.

Kopete::PropertyContainer::~PropertyContainer ( )

virtual

Definition at line 41 of file kopetepropertycontainer.cpp.

Member Function Documentation

void Kopete::PropertyContainer::deserializeProperties

(

const QMap< QString, QString > &

serializedData

)

Deserialize the contacts persistent properties.

Definition at line 63 of file kopetepropertycontainer.cpp.

bool Kopete::PropertyContainer::hasProperty

(

const QString &

key

)

const

Check for existence of a certain property stored using "key".

Parameters

key	the property to check for

Definition at line 106 of file kopetepropertycontainer.cpp.

QStringList Kopete::PropertyContainer::properties

(

)

const

Returns

A QStringList containing all property keys

Definition at line 101 of file kopetepropertycontainer.cpp.

const Property & Kopete::PropertyContainer::property

(

const QString &

key

)

const

Get the value of a property with key "key".

If you don't know the type of the returned QVariant, you will need to check for it.

Returns

the value of the property

Definition at line 111 of file kopetepropertycontainer.cpp.

const Kopete::Property & Kopete::PropertyContainer::property

(

const Kopete::PropertyTmpl &

tmpl

)

const

Definition at line 119 of file kopetepropertycontainer.cpp.

void Kopete::PropertyContainer::propertyChanged ( Kopete::PropertyContainer *  container, const QString &  key, const QVariant &  oldValue, const QVariant &  newValue  )

signal

void Kopete::PropertyContainer::removeProperty

(

const Kopete::PropertyTmpl &

tmpl

)

Remove a property if it exists.

Parameters

tmpl	the template this property is based on

Definition at line 158 of file kopetepropertycontainer.cpp.

void Kopete::PropertyContainer::serializeProperties

(

QMap< QString, QString > &

serializedData

)

const

Serialize the persistent properties for storage in the contact list.

Does the same as serialize() does but for KopeteContactProperties set in this contact with their persistency flag turned on. In contrary to serialize() this does not need to be reimplemented.

Definition at line 46 of file kopetepropertycontainer.cpp.

void Kopete::PropertyContainer::setProperty	(	const Kopete::PropertyTmpl &	tmpl,
		const QVariant &	value
	)

Add or Set a property for this contact.

Parameters

tmpl	The template this property is based on, key, label etc. are taken from this one
value	The value to store

Note

Setting a NULL value or an empty QString castable value removes the property if it already existed. Don't abuse this for property-removal, instead use removeProperty() if you want to remove on purpose. The Removal is done to clean up the list of properties and to purge them from UI.

Definition at line 129 of file kopetepropertycontainer.cpp.

---

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

• kopetepropertycontainer.h
• kopetepropertycontainer.cpp