KDE 4.2 API Reference kopete/libkopete
Kopete::Global::Properties Class Reference
#include <kopeteglobal.h>
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.
Public Member Functions | |
| const PropertyTmpl & | emailAddress () const |
| const PropertyTmpl & | firstName () const |
| const PropertyTmpl & | fullName () const |
| const PropertyTmpl & | idleTime () 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 () |
Member Function Documentation
| const PropertyTmpl & Kopete::Global::Properties::emailAddress | ( | ) | const |
- Returns:
- default template for a contact's email-address
Definition at line 198 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::firstName | ( | ) | const |
- Returns:
- default template for a contact's first name
Definition at line 162 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 126 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::idleTime | ( | ) | const |
| bool Kopete::Global::Properties::isRegistered | ( | const QString & | key | ) |
return true if a template with key key is already registered, false otherwise
Definition at line 121 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::lastName | ( | ) | const |
| const PropertyTmpl & Kopete::Global::Properties::lastSeen | ( | ) | const |
- Returns:
- default template for a contact's last-seen time
Definition at line 144 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::nickName | ( | ) | const |
- Returns:
- default template for a contact's nickname (set by the contact)
Definition at line 204 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 138 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 210 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::privateMobilePhone | ( | ) | const |
- Returns:
- default template for a contact's private mobile number
Definition at line 180 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::privatePhone | ( | ) | const |
- Returns:
- default template for a contact's private phone number
Definition at line 174 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 156 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::statusTitle | ( | ) | const |
- Returns:
- default template for a contact's status title
Definition at line 150 of file kopeteglobal.cpp.
| const PropertyTmpl::Map & Kopete::Global::Properties::templateMap | ( | ) | const |
- Returns:
- a map of all registered PropertyTmpl object
Definition at line 233 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 87 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::workMobilePhone | ( | ) | const |
- Returns:
- default template for a contact's work mobile number
Definition at line 192 of file kopeteglobal.cpp.
| const PropertyTmpl & Kopete::Global::Properties::workPhone | ( | ) | const |
- Returns:
- default template for a contact's work phone number
Definition at line 186 of file kopeteglobal.cpp.
The documentation for this class was generated from the following files:
