KWin::Scripting Class Reference

#include <scripting.h>

Inheritance diagram for KWin::Scripting:

Public Slots
void	scriptDestroyed (QObject *object)
Q_SCRIPTABLE void	start ()

Public Member Functions
	~Scripting () override
Q_SCRIPTABLE Q_INVOKABLE int	loadScript (const QString &filePath, const QString &pluginName=QString())
Q_SCRIPTABLE Q_INVOKABLE int	loadDeclarativeScript (const QString &filePath, const QString &pluginName=QString())
Q_SCRIPTABLE Q_INVOKABLE bool	isScriptLoaded (const QString &pluginName) const
Q_SCRIPTABLE Q_INVOKABLE bool	unloadScript (const QString &pluginName)
QList< QAction * >	actionsForUserActionMenu (Window *c, QMenu *parent)
	Invokes all registered callbacks to add actions to the UserActionsMenu.
QQmlEngine *	qmlEngine () const
QQmlEngine *	qmlEngine ()
QQmlContext *	declarativeScriptSharedContext () const
QQmlContext *	declarativeScriptSharedContext ()
QtScriptWorkspaceWrapper *	workspaceWrapper () const
AbstractScript *	findScript (const QString &pluginName) const

Static Public Member Functions
static Scripting *	self ()
static Scripting *	create (QObject *parent)

Detailed Description

The heart of KWin::Scripting. Infinite power lies beyond

Definition at line 309 of file scripting.h.

Constructor & Destructor Documentation

~Scripting()

KWin::Scripting::~Scripting ( )

override

Definition at line 834 of file scripting.cpp.

Member Function Documentation

actionsForUserActionMenu()

QList< QAction * > KWin::Scripting::actionsForUserActionMenu	(	KWin::Window *	c,
		QMenu *	parent )

Invokes all registered callbacks to add actions to the UserActionsMenu.

Parameters

c	The Client for which the UserActionsMenu is about to be shown
parent	The parent menu to which to add created child menus and items

Returns

QList< QAction* > List of all actions aggregated from all scripts.

Definition at line 840 of file scripting.cpp.

create()

KWin::Scripting * KWin::Scripting::create ( QObject * parent )

static

Definition at line 618 of file scripting.cpp.

declarativeScriptSharedContext() [1/2]

QQmlContext * KWin::Scripting::declarativeScriptSharedContext ( )

inline

Definition at line 383 of file scripting.h.

declarativeScriptSharedContext() [2/2]

QQmlContext * KWin::Scripting::declarativeScriptSharedContext ( ) const

inline

Definition at line 378 of file scripting.h.

findScript()

KWin::AbstractScript * KWin::Scripting::findScript

(

const QString &

pluginName

)

const

Definition at line 771 of file scripting.cpp.

isScriptLoaded()

bool KWin::Scripting::isScriptLoaded

(

const QString &

pluginName

)

const

Definition at line 766 of file scripting.cpp.

loadDeclarativeScript()

int KWin::Scripting::loadDeclarativeScript	(	const QString &	filePath,
		const QString &	pluginName = QString() )

Definition at line 821 of file scripting.cpp.

loadScript()

int KWin::Scripting::loadScript	(	const QString &	filePath,
		const QString &	pluginName = QString() )

Definition at line 808 of file scripting.cpp.

qmlEngine() [1/2]

QQmlEngine * KWin::Scripting::qmlEngine ( )

inline

Definition at line 373 of file scripting.h.

qmlEngine() [2/2]

QQmlEngine * KWin::Scripting::qmlEngine ( ) const

inline

Definition at line 368 of file scripting.h.

scriptDestroyed

void KWin::Scripting::scriptDestroyed ( QObject * object )

slot

Definition at line 802 of file scripting.cpp.

self()

Scripting * KWin::Scripting::self ( )

inlinestatic

Definition at line 393 of file scripting.h.

start

void KWin::Scripting::start ( )

slot

Definition at line 675 of file scripting.cpp.

unloadScript()

bool KWin::Scripting::unloadScript

(

const QString &

pluginName

)

Definition at line 782 of file scripting.cpp.

workspaceWrapper()

QtScriptWorkspaceWrapper * KWin::Scripting::workspaceWrapper ( ) const

inline

Definition at line 388 of file scripting.h.

---

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

• src/scripting/scripting.h
• src/scripting/scripting.cpp