KPeople::PersonData

KPeople::PersonData Class Reference

#include <persondata.h>

Inheritance diagram for KPeople::PersonData:

Properties

bool isEditable
 
QString name
 
QPixmap photo
 
QString presenceIconName
 
- Properties inherited from QObject
 objectName
 

Signals

void dataChanged ()
 

Public Member Functions

 PersonData (const QString &id, QObject *parent=nullptr)
 
QStringList allEmails () const
 
Q_SCRIPTABLE QVariant contactCustomProperty (const QString &key) const
 
QStringList contactUris () const
 
QString email () const
 
QStringList groups () const
 
bool isEditable () const
 
bool isValid () const
 
QString name () const
 
QString personUri () const
 
QPixmap photo () const
 
QUrl pictureUrl () const
 
QString presence () const
 
QString presenceIconName () const
 
Q_SCRIPTABLE bool setContactCustomProperty (const QString &key, const QVariant &value)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Allows to query the information about a given person.

PersonData exposes the information of a given person (in contrast to everyone available, which is done by PersonsModel). This class will provide comfortable interfaces so it can be easily adopted in any application.

Since
5.8

Definition at line 46 of file persondata.h.

Property Documentation

bool KPeople::PersonData::isEditable
read
Returns
whether setContactCustomProperty can be called on this contact
Since
5.62

Definition at line 58 of file persondata.h.

Constructor & Destructor Documentation

KPeople::PersonData::PersonData ( const QString id,
QObject parent = nullptr 
)

Creates a Person object from a given ID.

The ID can be either a local application specific ID (such as akonadi://?item=15) or a kpeople ID in the form kpeople://15

Definition at line 46 of file persondata.cpp.

Member Function Documentation

QStringList PersonData::allEmails ( ) const

Returns all e-mail addresses from the person.

Definition at line 209 of file persondata.cpp.

QVariant PersonData::contactCustomProperty ( const QString key) const
Returns
the property for a said key.

Definition at line 155 of file persondata.cpp.

QStringList PersonData::contactUris ( ) const

Returns a list of contact ids that identify the PersonData instance.

Definition at line 114 of file persondata.cpp.

void KPeople::PersonData::dataChanged ( )
signal

One of the contact sources has changed.

QString PersonData::email ( ) const

Returns the contact's preferred email address.

Definition at line 190 of file persondata.cpp.

QStringList PersonData::groups ( ) const

Returns all groups the person is in.

Definition at line 195 of file persondata.cpp.

bool KPeople::PersonData::isEditable ( ) const
Returns
whether the contact can be edited.
Since
5.62
bool PersonData::isValid ( ) const

Returns true if this PersonData is mapped to some existing contact.

Since
5.22

Definition at line 102 of file persondata.cpp.

QString KPeople::PersonData::name ( ) const
Returns
the name of the person
QString PersonData::personUri ( ) const

Returns the person's id.

Definition at line 108 of file persondata.cpp.

QPixmap KPeople::PersonData::photo ( ) const
Returns
a pixmap with the photo of the person, or a default one if not available
QUrl PersonData::pictureUrl ( ) const

Returns a the url of the picture that represents the contact.

Definition at line 185 of file persondata.cpp.

QString PersonData::presence ( ) const

Returns the contact's online presence.

Definition at line 180 of file persondata.cpp.

QString KPeople::PersonData::presenceIconName ( ) const
Returns
an icon name that represents the IM status of the person
bool KPeople::PersonData::setContactCustomProperty ( const QString key,
const QVariant value 
)

Sends a desired value for the contact according to the key.

It's not necessarily implemented. The back-end gets to decide whether a property can be set or not.

Returns
whether the property value was changed
Since
5.62

Definition at line 161 of file persondata.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jul 1 2020 22:44:10 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.