kwin/src/scripting/scriptingutils.h

/*
    KWin - the KDE window manager
    This file is part of the KDE project.

    SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>

    SPDX-License-Identifier: GPL-2.0-or-later
*/

#ifndef KWIN_SCRIPTINGUTILS_H
#define KWIN_SCRIPTINGUTILS_H

#include <QVariant>

namespace KWin
{

QVariant dbusToVariant(const QVariant &variant);

} // namespace KWin

#endif // KWIN_SCRIPTINGUTILS_H
Prettify license headers 2020-08-02 22:22:19 +00:00			`/*`
			`KWin - the KDE window manager`
			`This file is part of the KDE project.`
Global Shortcut support for KWin scripts and scripted Effects A global method "registerShortcut" is exported to the scripts which can be used to register a callback to be called when the global shortcut is triggered. The shared code between Scripts and Effects is moved into template functions defined in a new file scriptingutils.h. REVIEW: 104400 2012-03-25 07:59:01 +00:00
Prettify license headers 2020-08-02 22:22:19 +00:00			`SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>`
Global Shortcut support for KWin scripts and scripted Effects A global method "registerShortcut" is exported to the scripts which can be used to register a callback to be called when the global shortcut is triggered. The shared code between Scripts and Effects is moved into template functions defined in a new file scriptingutils.h. REVIEW: 104400 2012-03-25 07:59:01 +00:00
Prettify license headers 2020-08-02 22:22:19 +00:00			`SPDX-License-Identifier: GPL-2.0-or-later`
			`*/`
Global Shortcut support for KWin scripts and scripted Effects A global method "registerShortcut" is exported to the scripts which can be used to register a callback to be called when the global shortcut is triggered. The shared code between Scripts and Effects is moved into template functions defined in a new file scriptingutils.h. REVIEW: 104400 2012-03-25 07:59:01 +00:00
			`#ifndef KWIN_SCRIPTINGUTILS_H`
			`#define KWIN_SCRIPTINGUTILS_H`

[scripting] Port ScriptedEffects to QJSEngine Summary: QScriptEngine is deprecated for years and suffers bitrot. Plasma hit one super major bug with it in 5.11.0 and has now ported away. Main porting notes: - creating low level functions no longer exists The old global functions are exposed on the ScriptedEffect instance and then the QJSValue wrappers of the globalObject are modified to trampoline the methods at a wrapper level. - We can then use QJSEngine to automatically do argument error checking rather than unmarshalling a QJSValue manually which significantly reduces a lot of code. - We can't make FPX2 a native type, so these are QJSValue args and unboxed there. Long term I want overloads for animate that take int/QSize/QPoint which are native JS types, but that might be an API break. Test Plan: Hopefully comprehensive unit test which passes Tested fade/fadeDesktop manually. It's a very invasive change, so I expect some things will be broke please help test any JS effects. Reviewers: #kwin, mart, fvogt Subscribers: fvogt, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D14536 2021-02-01 21:08:56 +00:00			`#include <QVariant>`
Global Shortcut support for KWin scripts and scripted Effects A global method "registerShortcut" is exported to the scripts which can be used to register a callback to be called when the global shortcut is triggered. The shared code between Scripts and Effects is moved into template functions defined in a new file scriptingutils.h. REVIEW: 104400 2012-03-25 07:59:01 +00:00
			`namespace KWin`
			`{`

scripting: Port Script to QJSEngine QtScript is not well maintained and deprecated in favor of QJSEngine. 2021-01-24 11:56:42 +00:00			`QVariant dbusToVariant(const QVariant &variant);`
Allow Scripts to add menus to the UserActionsMenu A script can register a callback through registerUserActionsMenu to be informed when the UserActionsMenu is about to be shown. This menu calls the Scripting component to gather actions to add to a Scripts submenu. The Scripting component now asks all scripts for the actions, which will invoke the registered callbacks with the Client for which the menu is to be shown as argument. The callback is supposed to return a JSON structure describing how the menu should look like. The returned object can either be a menu item or a complete menu. If multiple menu items or menus are supposed to be added by the script it should just register multiple callbacks. The structure for an item looks like the following: { text: "My caption", checkable: true, checked: false, triggered: function (action) { print("The triggered action as parameter"); } } The structure for a complete menu looks quite similar: { text: "My menu caption", items: [ {...}, {...} // items as described above ] } The C++ part of the script parses the returned object and generates either QAction or QMenu from it. All objects become children of the scripts QMenu provided by the UserActionsMenu. Before the menu is shown again the existing menu is deleted to ensure that no outdated values from no longer existing scripts are around. This means the scripts are queried each time the menu is shown. FEATURE: 303756 FIXED-IN: 4.10 REVIEW: 106285 2012-08-31 11:28:31 +00:00
Global Shortcut support for KWin scripts and scripted Effects A global method "registerShortcut" is exported to the scripts which can be used to register a callback to be called when the global shortcut is triggered. The shared code between Scripts and Effects is moved into template functions defined in a new file scriptingutils.h. REVIEW: 104400 2012-03-25 07:59:01 +00:00			`} // namespace KWin`

			`#endif // KWIN_SCRIPTINGUTILS_H`