yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix documentation error for global KWin script method

Browse source 
SVN_SILENT
This commit is contained in:
Martin Gräßlin 2012-10-28 09:50:34 +01:00
parent 6417246358
commit 62dd1d57f0
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
scripting/documentation-global.xml
View file

@ -116,7 +116,8 @@
<memberdef kind="function"> <memberdef kind="function">
<type>Q_SCRIPTABLE void</type> <type>Q_SCRIPTABLE void</type>
<definition>void KWin::Scripting::registerUserActionsMenu</definition> <definition>void KWin::Scripting::registerUserActionsMenu</definition>
<argsstring>QScriptValue callback</argsstring> <argsstring>(QScriptValue callback)</argsstring>
<name>registerUserActionsMenu</name>
<read></read> <read></read>
<detaileddescription>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*/}</detaileddescription> <detaileddescription>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*/}</detaileddescription>
</memberdef> </memberdef>