KActivities::Controller Class Reference

#include <controller.h>

Inheritance diagram for KActivities::Controller:

Properties
QString	currentActivity
Properties inherited from KActivities::Consumer
QStringList	activities
QString	currentActivity
QStringList	runningActivities
ServiceStatus	serviceStatus
Properties inherited from QObject
	objectName

Public Member Functions
	Controller (QObject *parent=nullptr)
QFuture< QString >	addActivity (const QString &name)
QFuture< void >	nextActivity ()
QFuture< void >	previousActivity ()
QFuture< void >	removeActivity (const QString &id)
QFuture< void >	setActivityDescription (const QString &id, const QString &description)
QFuture< void >	setActivityIcon (const QString &id, const QString &icon)
QFuture< void >	setActivityName (const QString &id, const QString &name)
QFuture< bool >	setCurrentActivity (const QString &id)
QFuture< void >	startActivity (const QString &id)
QFuture< void >	stopActivity (const QString &id)
Public Member Functions inherited from KActivities::Consumer
	Consumer (QObject *parent=nullptr)
QStringList	activities () const
QStringList	activities (Info::State state) const
QString	currentActivity () const
QStringList	runningActivities () const
ServiceStatus	serviceStatus ()
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 KActivities::Consumer
enum	ServiceStatus { NotRunning , Unknown , Running }
Signals inherited from KActivities::Consumer
void	activitiesChanged (const QStringList &activities)
void	activityAdded (const QString &id)
void	activityRemoved (const QString &id)
void	currentActivityChanged (const QString &id)
void	runningActivitiesChanged (const QStringList &runningActivities)
void	serviceStatusChanged (Consumer::ServiceStatus status)
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

This class provides methods for controlling and managing the activities.

Note

The QFuture objects returned by these methods are not thread-based, you can not call synchronous methods like waitForFinished, cancel, pause on them. You need either to register watchers to check when those have finished, or to check whether they are ready from time to time manually.

See also

Consumer for info about activities

Since

5.0

Definition at line 37 of file controller.h.

Property Documentation

currentActivity

QString KActivities::Controller::currentActivity

readwrite

Definition at line 41 of file controller.h.

Constructor & Destructor Documentation

Controller()

KActivities::Controller::Controller ( QObject * parent = nullptr )

explicit

Definition at line 19 of file controller.cpp.

Member Function Documentation

addActivity()

QFuture< QString > KActivities::Controller::addActivity

(

const QString &

name

)

Adds a new activity.

Parameters

name	name of the activity

Returns

id of the newly created activity

Definition at line 55 of file controller.cpp.

nextActivity()

QFuture< void > KActivities::Controller::nextActivity

(

)

Switches to the next activity.

Definition at line 96 of file controller.cpp.

previousActivity()

QFuture< void > KActivities::Controller::previousActivity

(

)

Switches to the previous activity.

Definition at line 91 of file controller.cpp.

removeActivity()

QFuture< void > KActivities::Controller::removeActivity

(

const QString &

id

)

Removes the specified activity.

Parameters

id	id of the activity to delete

Definition at line 64 of file controller.cpp.

setActivityDescription()

QFuture< void > KActivities::Controller::setActivityDescription	(	const QString &	id,
		const QString &	description )

Sets the description of the specified activity.

Parameters

id	id of the activity
description	description to be set

setActivityIcon()

QFuture< void > KActivities::Controller::setActivityIcon	(	const QString &	id,
		const QString &	icon )

Sets the icon of the specified activity.

Parameters

id	id of the activity
icon	icon to be set - freedesktop.org name or file path

setActivityName()

QFuture< void > KActivities::Controller::setActivityName	(	const QString &	id,
		const QString &	name )

Sets the name of the specified activity.

Parameters

id	id of the activity
name	name to be set

setCurrentActivity()

QFuture< bool > KActivities::Controller::setCurrentActivity

(

const QString &

id

)

Sets the current activity.

Parameters

id	id of the activity to make current

Returns

true if successful

Definition at line 45 of file controller.cpp.

startActivity()

QFuture< void > KActivities::Controller::startActivity

(

const QString &

id

)

Starts the activity.

Parameters

id	id of the activity to start

Definition at line 82 of file controller.cpp.

stopActivity()

QFuture< void > KActivities::Controller::stopActivity

(

const QString &

id

)

Stops the activity.

Parameters

id	id of the activity to stop

Definition at line 73 of file controller.cpp.

---

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

• controller.h
• controller.cpp