Plasma::ContainmentActions

#include <Plasma/ContainmentActions>

Inheritance diagram for Plasma::ContainmentActions:

Public Member Functions

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

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 *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)
 

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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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 55 of file containmentactions.h.

Constructor & Destructor Documentation

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

Default constructor for an empty or null containmentactions.

Definition at line 39 of file containmentactions.cpp.

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
parenta QObject parent; you probably want to pass in 0
argsa list of strings containing one entry: the service id

Definition at line 45 of file containmentactions.cpp.

Member Function Documentation

void Plasma::ContainmentActions::configurationAccepted ( )
virtual

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

Definition at line 98 of file containmentactions.cpp.

Containment * Plasma::ContainmentActions::containment ( )
Returns
the containment the plugin is associated with.

Definition at line 74 of file containmentactions.cpp.

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 113 of file containmentactions.cpp.

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 92 of file containmentactions.cpp.

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 118 of file containmentactions.cpp.

KPluginMetaData Plasma::ContainmentActions::metadata ( ) const
Returns
metadata for this ContainmentActions instance including name, pluginName and icon
Since
5.67

Definition at line 69 of file containmentactions.cpp.

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 103 of file containmentactions.cpp.

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 108 of file containmentactions.cpp.

KPluginInfo Plasma::ContainmentActions::pluginInfo ( ) const
Returns
the plugin info for this ContainmentActions instance, including name, pluginName and icon
Since
5.0
Deprecated:
since 5.67, use metadata

Definition at line 64 of file containmentactions.cpp.

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

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

Parameters
configConfig group to load settings
See also
init

Definition at line 82 of file containmentactions.cpp.

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

This method is called when settings need to be saved.

Parameters
configConfig group to save settings

Definition at line 87 of file containmentactions.cpp.

void Plasma::ContainmentActions::setContainment ( Containment newContainment)

newContainment the containment the plugin should be associated with.

Since
4.6

Definition at line 167 of file containmentactions.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 Fri Jun 5 2020 22:52:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.