Plasma::ContainmentActions Class Reference

#include <Plasma/ContainmentActions>

Inheritance diagram for Plasma::ContainmentActions:

Public Member Functions
	ContainmentActions (QObject *parent=nullptr)
virtual void	configurationAccepted ()
Containment *	containment ()
virtual QList< QAction * >	contextualActions ()
virtual QWidget *	createConfigurationInterface (QWidget *parent)
KPluginMetaData	metadata () const
virtual void	performNextAction ()
virtual void	performPreviousAction ()
virtual void	restore (const KConfigGroup &config)
virtual void	save (KConfigGroup &config)
void	setContainment (Containment *newContainment)
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

Static Public Member Functions
static QString	eventToString (QEvent *event)
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
	ContainmentActions (QObject *parent, const QVariantList &args)
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)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

The base ContainmentActions class.

"ContainmentActions" are components that provide actions (usually displaying a contextmenu) in response to an event with a position (usually a mouse event).

ContainmentActions plugins are registered using .desktop files. These files should be named using the following naming scheme:

plasma-containmentactions-\<pluginname\>.desktop

Definition at line 40 of file containmentactions.h.

Constructor & Destructor Documentation

ContainmentActions() [1/2]

Plasma::ContainmentActions::ContainmentActions ( QObject * parent = nullptr )

explicit

Default constructor for an empty or null containmentactions.

Definition at line 23 of file containmentactions.cpp.

~ContainmentActions()

Plasma::ContainmentActions::~ContainmentActions ( )

override

Definition at line 43 of file containmentactions.cpp.

ContainmentActions() [2/2]

Plasma::ContainmentActions::ContainmentActions ( QObject * parent, const QVariantList & args )

protected

This constructor is to be used with the plugin loading systems found in KPluginInfo and KService.

The argument list is expected to have one element: the KService service ID for the desktop entry.

Parameters

parent	a QObject parent; you probably want to pass in 0
args	a list of strings containing one entry: the service id

Definition at line 29 of file containmentactions.cpp.

Member Function Documentation

configurationAccepted()

void Plasma::ContainmentActions::configurationAccepted ( )

virtual

This method is called when the user's configuration changes are accepted.

Definition at line 77 of file containmentactions.cpp.

containment()

Containment * Plasma::ContainmentActions::containment

(

)

Returns

the containment the plugin is associated with.

Definition at line 53 of file containmentactions.cpp.

contextualActions()

QList< QAction * > Plasma::ContainmentActions::contextualActions ( )

virtual

Implement this to provide a list of actions that can be added to another menu for example, when right-clicking an applet, the "Activity Options" submenu is populated with this.

Definition at line 92 of file containmentactions.cpp.

createConfigurationInterface()

QWidget * Plasma::ContainmentActions::createConfigurationInterface ( QWidget * parent )

virtual

Returns the widget used in the configuration dialog.

Add the configuration interface of the containmentactions to this widget.

Definition at line 71 of file containmentactions.cpp.

eventToString()

QString Plasma::ContainmentActions::eventToString ( QEvent * event )

static

Turns a mouse or wheel event into a string suitable for a ContainmentActions.

Returns

the string representation of the event

Definition at line 97 of file containmentactions.cpp.

metadata()

KPluginMetaData Plasma::ContainmentActions::metadata

(

)

const

Returns

metadata for this ContainmentActions instance including name, pluginName and icon

Since

5.67

Definition at line 48 of file containmentactions.cpp.

performNextAction()

void Plasma::ContainmentActions::performNextAction ( )

virtual

Called when a "next" action is triggered (e.g.

by mouse wheel scroll). This can be used to scroll through a list of items this plugin manages such as windows, virtual desktops, activities, etc.

See also

performPrevious

Definition at line 82 of file containmentactions.cpp.

performPreviousAction()

void Plasma::ContainmentActions::performPreviousAction ( )

virtual

Called when a "previous" action is triggered (e.g.

by mouse wheel scroll). This can be used to scroll through a list of items this plugin manages such as windows, virtual desktops, activities, etc.

See also

performNext

Definition at line 87 of file containmentactions.cpp.

restore()

void Plasma::ContainmentActions::restore ( const KConfigGroup & config )

virtual

This method should be called once the plugin is loaded or settings are changed.

Parameters

config

Config group to load settings

See also

init

Definition at line 61 of file containmentactions.cpp.

save()

void Plasma::ContainmentActions::save ( KConfigGroup & config )

virtual

This method is called when settings need to be saved.

Parameters

config

Config group to save settings

Definition at line 66 of file containmentactions.cpp.

setContainment()

void Plasma::ContainmentActions::setContainment

(

Containment *

newContainment

)

newContainment the containment the plugin should be associated with.

Since

4.6

Definition at line 140 of file containmentactions.cpp.

---

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

• containmentactions.h
• containmentactions.cpp