KUserProxy Class Reference

#include <kuserproxy.h>

Inheritance diagram for KUserProxy:

Properties
QUrl	faceIconUrl
QString	fullName
QString	host
QString	loginName
QString	os
Properties inherited from QObject
	objectName

Signals
void	faceIconUrlChanged ()
void	nameChanged ()

Public Member Functions
	KUserProxy (QObject *parent=nullptr)
QUrl	faceIconUrl () const
QString	fullName () const
QString	host () const
QString	loginName () const
QString	os ()
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
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)
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

KUserProxy (exposed as KUser to the QML runtime) is an object allowing read-only access to the user's name, os and version and the configured user image.

This object can be used to personalize user interfaces.

Example usage:

import org.kde.coreaddons as KCoreAddons
[...]
 
Item {
    [...]
    KCoreAddons.KUser {
        id: kuser
    }
 
    Image {
        id: faceIcon
        source: kuser.faceIconUrl
        [...]
    }
 
    Text {
        text: kuser.fullName
        [...]
    }
}

KUser provides read-only access to the user's personal information

See also

KUser

Definition at line 49 of file kuserproxy.h.

Property Documentation

faceIconUrl

QUrl KUserProxy::faceIconUrl

read

Definition at line 55 of file kuserproxy.h.

fullName

QString KUserProxy::fullName

read

Definition at line 53 of file kuserproxy.h.

host

QString KUserProxy::host

read

Definition at line 57 of file kuserproxy.h.

loginName

QString KUserProxy::loginName

read

Definition at line 54 of file kuserproxy.h.

os

QString KUserProxy::os

read

Definition at line 56 of file kuserproxy.h.

Constructor & Destructor Documentation

KUserProxy()

KUserProxy::KUserProxy

(

QObject *

parent = nullptr

)

Definition at line 18 of file kuserproxy.cpp.

~KUserProxy()

KUserProxy::~KUserProxy ( )

override

Definition at line 41 of file kuserproxy.cpp.

Member Function Documentation

faceIconUrl()

QUrl KUserProxy::faceIconUrl

(

)

const

Returns

the url of the user's configured image (including file:/)

See also

faceIconUrlChanged

Definition at line 77 of file kuserproxy.cpp.

faceIconUrlChanged

void KUserProxy::faceIconUrlChanged ( )

signal

signal that the user image changed

See also

faceIconUrl

fullName()

QString KUserProxy::fullName

(

)

const

Returns

the full name of the user

See also

nameChanged

Definition at line 63 of file kuserproxy.cpp.

host()

QString KUserProxy::host

(

)

const

Returns

the system's hostname

See also

nameChanged

Definition at line 119 of file kuserproxy.cpp.

loginName()

QString KUserProxy::loginName

(

)

const

Returns

the user's login name

See also

nameChanged

Definition at line 72 of file kuserproxy.cpp.

nameChanged

void KUserProxy::nameChanged ( )

signal

signal that the user's name or login name changed

See also

fullName

loginName

os()

QString KUserProxy::os

(

)

Returns

pretty name indicating operating system and version

See also

nameChanged

---

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

• kuserproxy.h
• kuserproxy.cpp