diff --git a/scripting/documentation-global.xml b/scripting/documentation-global.xml index 6ba2e258d7..edfe379080 100644 --- a/scripting/documentation-global.xml +++ b/scripting/documentation-global.xml @@ -116,7 +116,8 @@ Q_SCRIPTABLE void void KWin::Scripting::registerUserActionsMenu - QScriptValue callback + (QScriptValue callback) + registerUserActionsMenu Registers the passed in callback to be invoked whenever the User actions menu (Alt+F3 or right click on window decoration) is about to be shown. The callback is invoked with a reference to the Client for which the menu is shown. The callback can return either a single menu entry to be added to the menu or an own sub menu with multiple entries. The object for a menu entry should be {title: "My Menu entry", checkable: true, checked: false, triggered: function (action) { // callback with triggered QAction}}, for a menu it should be {title: "My menu", items: [{...}, {...}, ...] /*list with entries as described*/}