Kopete::Global::Properties Class Reference

#include <kopeteglobal.h>

Public Member Functions
const PropertyTmpl &	customName () const
const PropertyTmpl &	emailAddress () const
const PropertyTmpl &	firstName () const
const PropertyTmpl &	fullName () const
const PropertyTmpl &	idleTime () const
const PropertyTmpl &	isAlwaysVisible () const
bool	isRegistered (const QString &key)
const PropertyTmpl &	lastName () const
const PropertyTmpl &	lastSeen () const
const PropertyTmpl &	nickName () const
const PropertyTmpl &	onlineSince () const
const PropertyTmpl &	photo () const
const PropertyTmpl &	privateMobilePhone () const
const PropertyTmpl &	privatePhone () const
const PropertyTmpl &	statusMessage () const
const PropertyTmpl &	statusTitle () const
const PropertyTmpl::Map &	templateMap () const
const PropertyTmpl &	tmpl (const QString &key) const
const PropertyTmpl &	workMobilePhone () const
const PropertyTmpl &	workPhone () const

Static Public Member Functions
static Properties *	self ()

Detailed Description

Global facility to query/store templates that are needed by KopeteProperty.

Basically all a plugin author needs to worry about is creating PropertyTmpl objects for all the properties he wants to set for a Kopete::Contact, everything else is handled behind the scenes.

Definition at line 45 of file kopeteglobal.h.

Member Function Documentation

const PropertyTmpl & Kopete::Global::Properties::customName

(

)

const

Returns

default template for a contact's nickname (set by the contact) This property is set by user and stored on server contact list

Definition at line 212 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::emailAddress

(

)

const

Returns

default template for a contact's email-address

Definition at line 200 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::firstName

(

)

const

Returns

default template for a contact's first name

Definition at line 164 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::fullName

(

)

const

Returns

a ready-to-use template for a contact's full name.

This is actually no real property, it makes use of firstName() and lastName() to assemble an name that consists of both name parts

Definition at line 128 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::idleTime

(

)

const

Return default template for a contact's idle-time.

Definition at line 134 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::isAlwaysVisible

(

)

const

Returns

default template for a contact's visibility even if offline

Definition at line 218 of file kopeteglobal.cpp.

bool Kopete::Global::Properties::isRegistered

(

const QString &

key

)

return true if a template with key key is already registered, false otherwise

Definition at line 123 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::lastName

(

)

const

Returns

default template for a contact's last name

Definition at line 170 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::lastSeen

(

)

const

Returns

default template for a contact's last-seen time

Definition at line 146 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::nickName

(

)

const

Returns

default template for a contact's nickname (set by the contact) This property comes from contact and cannot be changed by user custom name

Definition at line 206 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::onlineSince

(

)

const

Return default template for a contact's online-since time (i.e.

time since he went from offline to online)

Definition at line 140 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::photo

(

)

const

default template for a contact's photo.

It could be either a QString or a QImage. If it's a QString, it should points to the path the image is stored.

Definition at line 224 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::privateMobilePhone

(

)

const

Returns

default template for a contact's private mobile number

Definition at line 182 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::privatePhone

(

)

const

Returns

default template for a contact's private phone number

Definition at line 176 of file kopeteglobal.cpp.

Properties * Kopete::Global::Properties::self ( )

static

Singleton accessor for this class.

Use it to access the global list of property-templates or to get a reference to one of the common PropertyTmpl objects

Definition at line 49 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::statusMessage

(

)

const

Returns

default template for a contact's status message

Definition at line 158 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::statusTitle

(

)

const

Returns

default template for a contact's status title

Definition at line 152 of file kopeteglobal.cpp.

const PropertyTmpl::Map & Kopete::Global::Properties::templateMap

(

)

const

Returns

a map of all registered PropertyTmpl object

Definition at line 247 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::tmpl

(

const QString &

key

)

const

Return a template with defined by key, if no such template has been registered PropertyTmpl::null will be returned.

Definition at line 89 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::workMobilePhone

(

)

const

Returns

default template for a contact's work mobile number

Definition at line 194 of file kopeteglobal.cpp.

const PropertyTmpl & Kopete::Global::Properties::workPhone

(

)

const

Returns

default template for a contact's work phone number

Definition at line 188 of file kopeteglobal.cpp.

---

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

• kopeteglobal.h
• kopeteglobal.cpp