Plasma::AppletScript Class Reference

#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::Applet *	applet () 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 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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
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 QRegExp &regExp, 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
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 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_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
T	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)
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	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)
QThread *	thread () 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
QObject *	sender () 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 *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)
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 35 of file appletscript.h.

Constructor & Destructor Documentation

AppletScript()

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 25 of file appletscript.cpp.

Member Function Documentation

applet()

Applet * Plasma::AppletScript::applet

(

)

const

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

Definition at line 42 of file appletscript.cpp.

configChanged

void Plasma::AppletScript::configChanged ( )

virtualslot

Configure was changed.

Definition at line 86 of file appletscript.cpp.

configNeedsSaving()

void Plasma::AppletScript::configNeedsSaving

(

)

const

See also

Applet

Definition at line 79 of file appletscript.cpp.

constraintsEvent()

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

constraints

the type of constraints that were updated

Definition at line 48 of file appletscript.cpp.

containmentType()

Plasma::Types::ContainmentType Plasma::AppletScript::containmentType

(

)

const

See also

Containment

Since

4.7

Definition at line 112 of file appletscript.cpp.

contextualActions()

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 53 of file appletscript.cpp.

description()

KPluginInfo Plasma::AppletScript::description ( ) const

protected

Returns

the KPluginInfo associated with this plasmoid

Deprecated:

since 5.81, use applet()->pluginMetaData() instead.

Definition at line 105 of file appletscript.cpp.

mainScript()

QString Plasma::AppletScript::mainScript ( ) const

overrideprotectedvirtual

Returns

absolute path to the main script file for this plasmoid

Reimplemented from Plasma::ScriptEngine.

Definition at line 90 of file appletscript.cpp.

package()

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 97 of file appletscript.cpp.

saveState

void Plasma::AppletScript::saveState ( KConfigGroup &  group ) const

signal

See also

Applet

setApplet()

void Plasma::AppletScript::setApplet

(

Plasma::Applet *

applet

)

Sets the applet associated with this AppletScript.

Definition at line 37 of file appletscript.cpp.

setConfigurationRequired()

void Plasma::AppletScript::setConfigurationRequired	(	bool	req,
		const QString &	reason = QString()
	)

See also

Applet

Definition at line 65 of file appletscript.cpp.

setContainmentType()

void Plasma::AppletScript::setContainmentType

(

Plasma::Types::ContainmentType

type

)

See also

Containment

Since

4.7

Definition at line 123 of file appletscript.cpp.

setHasConfigurationInterface()

void Plasma::AppletScript::setHasConfigurationInterface

(

bool

hasInterface

)

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

Parameters

hasInterface

true if the applet is user configurable

Definition at line 58 of file appletscript.cpp.

setLaunchErrorMessage()

void Plasma::AppletScript::setLaunchErrorMessage

(

const QString &

reason = QString()

)

See also

Applet

Definition at line 72 of file appletscript.cpp.

uiReadyChanged

void Plasma::AppletScript::uiReadyChanged ( bool  uiReady )

signal

Parameters

uiReady

true if the UI for this applet is ready

---

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

• appletscript.h
• appletscript.cpp