Plasma::AppletScript

Search for usage in LXR

#include <Plasma/Scripting/AppletScript>

Inheritance diagram for Plasma::AppletScript:

Signals

void saveState (KConfigGroup &group) const
 
void uiReadyChanged (bool uiReady)
 

Public Slots

virtual void configChanged ()
 

Public Member Functions

 AppletScript (QObject *parent=nullptr)
 
Plasma::Appletapplet () const
 
void configNeedsSaving () const
 
virtual void constraintsEvent (Plasma::Types::Constraints constraints)
 
Plasma::Types::ContainmentType containmentType () const
 
virtual QList< QAction * > contextualActions ()
 
void setApplet (Plasma::Applet *applet)
 
void setConfigurationRequired (bool req, const QString &reason=QString())
 
void setContainmentType (Plasma::Types::ContainmentType type)
 
void setHasConfigurationInterface (bool hasInterface)
 
void setLaunchErrorMessage (const QString &reason=QString())
 
- Public Member Functions inherited from Plasma::ScriptEngine
virtual bool init ()
 
- 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
 

Protected Member Functions

KPluginInfo description () const
 
QString mainScript () const override
 
Package package () const override
 
- Protected Member Functions inherited from Plasma::ScriptEngine
 ScriptEngine (QObject *parent=nullptr)
 
- 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
 
- 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

Provides a restricted interface for scripted applets.

Definition at line 33 of file appletscript.h.

Constructor & Destructor Documentation

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

Default constructor for an AppletScript.

Subclasses should not attempt to access the Plasma::Applet associated with this AppletScript in the constructor. All such set up that requires the Applet itself should be done in the init() method.

Definition at line 23 of file appletscript.cpp.

Member Function Documentation

Applet * Plasma::AppletScript::applet ( ) const

Returns the Plasma::Applet associated with this script component.

Definition at line 40 of file appletscript.cpp.

void Plasma::AppletScript::configChanged ( )
virtualslot

Configure was changed.

Definition at line 84 of file appletscript.cpp.

void Plasma::AppletScript::configNeedsSaving ( ) const
See also
Applet

Definition at line 77 of file appletscript.cpp.

void Plasma::AppletScript::constraintsEvent ( Plasma::Types::Constraints  constraints)
virtual

Called when any of the geometry constraints have been updated.

This is always called prior to painting and should be used as an opportunity to layout the widget, calculate sizings, etc.

Do not call update() from this method; an update() will be triggered at the appropriate time for the applet.

Parameters
constraintsthe type of constraints that were updated

Definition at line 46 of file appletscript.cpp.

Plasma::Types::ContainmentType Plasma::AppletScript::containmentType ( ) const
See also
Containment
Since
4.7

Definition at line 108 of file appletscript.cpp.

QList< QAction * > Plasma::AppletScript::contextualActions ( )
virtual

Returns a list of context-related QAction instances.

Returns
A list of actions. The default implementation returns an empty list.

Definition at line 51 of file appletscript.cpp.

KPluginInfo Plasma::AppletScript::description ( ) const
protected
Returns
the KPluginInfo associated with this plasmoid
Deprecated:
since 5.81, use applet()->pluginMetaData() instead.

Definition at line 101 of file appletscript.cpp.

QString Plasma::AppletScript::mainScript ( ) const
overrideprotectedvirtual
Returns
absolute path to the main script file for this plasmoid

Reimplemented from Plasma::ScriptEngine.

Definition at line 88 of file appletscript.cpp.

Package Plasma::AppletScript::package ( ) const
overrideprotectedvirtual
Returns
the Package associated with this plasmoid which can be used to request resources, such as images and interface files.

Reimplemented from Plasma::ScriptEngine.

Definition at line 94 of file appletscript.cpp.

void Plasma::AppletScript::saveState ( KConfigGroup group) const
signal
See also
Applet
void Plasma::AppletScript::setApplet ( Plasma::Applet applet)

Sets the applet associated with this AppletScript.

Definition at line 35 of file appletscript.cpp.

void Plasma::AppletScript::setConfigurationRequired ( bool  req,
const QString reason = QString() 
)
See also
Applet

Definition at line 63 of file appletscript.cpp.

void Plasma::AppletScript::setContainmentType ( Plasma::Types::ContainmentType  type)
See also
Containment
Since
4.7

Definition at line 119 of file appletscript.cpp.

void Plasma::AppletScript::setHasConfigurationInterface ( bool  hasInterface)

Sets whether or not this script has a configuration interface or not.

Parameters
hasInterfacetrue if the applet is user configurable

Definition at line 56 of file appletscript.cpp.

void Plasma::AppletScript::setLaunchErrorMessage ( const QString reason = QString())
See also
Applet

Definition at line 70 of file appletscript.cpp.

void Plasma::AppletScript::uiReadyChanged ( bool  uiReady)
signal
Parameters
uiReadytrue if the UI for this applet is ready

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Apr 22 2021 22:41:35 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.