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)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
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
QObject *	sender () 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 34 of file persondata.h.

Property Documentation

isEditable

bool KPeople::PersonData::isEditable

read

Returns

whether setContactCustomProperty can be called on this contact

Since

5.62

Definition at line 46 of file persondata.h.

name

QString KPeople::PersonData::name

read

Definition at line 37 of file persondata.h.

photo

QPixmap KPeople::PersonData::photo

read

Definition at line 38 of file persondata.h.

presenceIconName

QString KPeople::PersonData::presenceIconName

read

Definition at line 39 of file persondata.h.

Constructor & Destructor Documentation

PersonData()

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 35 of file persondata.cpp.

~PersonData()

PersonData::~PersonData ( )

override

Definition at line 87 of file persondata.cpp.

Member Function Documentation

allEmails()

QStringList PersonData::allEmails

(

)

const

Returns all e-mail addresses from the person.

Definition at line 199 of file persondata.cpp.

contactCustomProperty()

QVariant PersonData::contactCustomProperty

(

const QString &

key

)

const

Returns

the property for a said key.

Definition at line 145 of file persondata.cpp.

contactUris()

QStringList PersonData::contactUris

(

)

const

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

Definition at line 104 of file persondata.cpp.

dataChanged

void KPeople::PersonData::dataChanged ( )

signal

One of the contact sources has changed.

email()

QString PersonData::email

(

)

const

Returns the contact's preferred email address.

Definition at line 180 of file persondata.cpp.

groups()

QStringList PersonData::groups

(

)

const

Returns all groups the person is in.

Definition at line 185 of file persondata.cpp.

isEditable()

bool KPeople::PersonData::isEditable

(

)

const

Returns

whether the contact can be edited.

Since

5.62

Definition at line 211 of file persondata.cpp.

isValid()

bool PersonData::isValid

(

)

const

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

Since

5.22

Definition at line 92 of file persondata.cpp.

name()

QString PersonData::name

(

)

const

Returns

the name of the person

Definition at line 165 of file persondata.cpp.

personUri()

QString PersonData::personUri

(

)

const

Returns the person's id.

Definition at line 98 of file persondata.cpp.

photo()

QPixmap PersonData::photo

(

)

const

Returns

a pixmap with the photo of the person, or a default one if not available

Definition at line 128 of file persondata.cpp.

pictureUrl()

QUrl PersonData::pictureUrl

(

)

const

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

Definition at line 175 of file persondata.cpp.

presence()

QString PersonData::presence

(

)

const

Returns the contact's online presence.

Definition at line 170 of file persondata.cpp.

presenceIconName()

QString PersonData::presenceIconName

(

)

const

Returns

an icon name that represents the IM status of the person

Definition at line 159 of file persondata.cpp.

setContactCustomProperty()

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 151 of file persondata.cpp.

---

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

• persondata.h
• persondata.cpp