KDE TechBase - User contributions [en]

Projects/KWin

2013-02-07T08:34:29Z

Mgraesslin: SVN -> git

'''This is a starting page for all relevant KWin documentation, most of which is stored in git or on external WWW pages.'''

== General information ==

* [https://mail.kde.org/mailman/listinfo/kwin KWin mailing list]
* IRC channel #kwin on freenode
* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/COMPLIANCE COMPLIANCE] - a document on KWin's compliance to the window manager specifications [http://tronche.com/gui/x/icccm/ ICCCM] and [http://www.freedesktop.org/wiki/Specifications/wm-spec EWMH] (also known as NETWM).
* [[/4.0-release-notes|KDE4.0 release notes]] - information about changes and new features in KWin in KDE4.0
* [[/Build_Options|KWin Build Options]] - documentation on the available build options for KWin.

== Developer information ==

* For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki
* http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkdecorations/html/index.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version).
* [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does.
* [http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkwineffects/html/index.html libkwineffects API documentation ] - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [https://projects.kde.org/projects/kde/kdebase/kde-workspace/repository/revisions/master/show/kwin/effects existing effects shipped with KWin] and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.
* [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
* [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]]

== Configuration ==

* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/CONFIGURING CONFIGURING ] - document on advanced KWin configuration (such as pre-configuring window-specific settings).

Projects/KWin

2013-02-07T08:33:58Z

Mgraesslin: update links

'''This is a starting page for all relevant KWin documentation, most of which is stored in SVN or on external WWW pages.'''

== General information ==

* [https://mail.kde.org/mailman/listinfo/kwin KWin mailing list]
* IRC channel #kwin on freenode
* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/COMPLIANCE COMPLIANCE] - a document on KWin's compliance to the window manager specifications [http://tronche.com/gui/x/icccm/ ICCCM] and [http://www.freedesktop.org/wiki/Specifications/wm-spec EWMH] (also known as NETWM).
* [[/4.0-release-notes|KDE4.0 release notes]] - information about changes and new features in KWin in KDE4.0
* [[/Build_Options|KWin Build Options]] - documentation on the available build options for KWin.

== Developer information ==

* For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki
* http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkdecorations/html/index.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version).
* [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does.
* [http://api.kde.org/4.x-api/kde-workspace-apidocs/kwin/libkwineffects/html/index.html libkwineffects API documentation ] - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [https://projects.kde.org/projects/kde/kdebase/kde-workspace/repository/revisions/master/show/kwin/effects existing effects shipped with KWin] and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.
* [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
* [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]]

== Configuration ==

* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/CONFIGURING CONFIGURING ] - document on advanced KWin configuration (such as pre-configuring window-specific settings).

Schedules/KDE4/4.10 Feature Plan

2013-02-01T12:17:53Z

Mgraesslin: Updated KWin section from bug reports

This is a list of planned features for the SC 4.10 release.

See also:

*[[Schedules/KDE4/4.10 Release Schedule]]
*[[Schedules/KDE4/4.9 Feature Plan]] (previous major release)

 Legend:

*to do => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
|}
NO NEW FEATURES ALLOWED
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureDone|QML Containments|Making it possible to do full-featured containments in QML|sebas@kde.org|Sebastian Kügler}}
{{FeatureDone|nepomuk-indexer|New Nepomuk Indexer|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomukbackup|Nepomuk Backup rewritten from scratch|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomukcleaner|An application to port/clean invalid/legacy data in Nepomuk|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomuk KCM|Rewrite the Nepomuk KCM|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomuk tags|Nepomuk Tags KIO Slave|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}


{{FeatureDone|kwin|Decorations not visible ({{bug |305875}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Display application menu and title bar side by side for maximized windows ({{bug |102607}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|drag-and-drop between windows by cover switch alt-tab causes apps to crash ({{bug |179077}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add a rule to select the screen ({{bug |183996}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Need Mouse navigation in flip switch mode ({{bug |244439}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add support for appmenu-qt ({{bug |266596}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|glsl should be disabled for the 945G because it's slow and broken ({{bug |293385}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|When starting the present windows effect, windows that are partly out of screen jump to the screens center ({{bug |294428}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GHNS support for Scripted Effects ({{bug |296773}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Allow direct rendering with fglrx ({{bug |301103}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Show Desktop has inconsistent behavior when launching KRunner ({{bug |302248}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Don't use OpenGL matrix stack in OpenGL 2 backend ({{bug |303093}}, Review 105455)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Refactor Screen/Window PaintData ({{bug |303314}}, Review 105141)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Rapid flickering in locked screen -- makes it difficult to unlock ({{bug |303579}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|double click menu to close needs GUI config ({{bug |305738}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Toplevel::windowType() needs performance improvements ({{bug |306384}}, Review 106349)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GLPlatform should recommend either OpenGL1 or OpenGL2 compositing ({{bug |306436}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Zoom effect broken in master ({{bug |307609}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin fails to build when the GLES support is disabled ({{bug |307866}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Some effect authors are listed as "Name1 & Name2" ({{bug |307928}}, Review 106880)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes after restarting it ({{bug |308040}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|When compositing is disabled, opening a window which blocks compositing *enables* it ({{bug |308438}}, Review 106900)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Forgotten "${...}" witihin CMakeLists.txt ({{bug |308759}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Animate Window Maximize/Restore ({{bug |308990}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Move ExtendedBorderRegion to stable API ({{bug |308994}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Support shortened titles like in bespin in all decorations ({{bug |308995}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Mouse Click effect ({{bug |309006}}, Review 105780)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin kcm wrongly informs that all effects failed to load ({{bug |309853}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crash due to wobbly windows effect when closing window ({{bug |310142}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Snap helper window effect doesn't repaint background when resizing the window ({{bug |311551}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|No minimum size on the general or effects tab of kwincompositing kcm ({{bug |311553}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|callDBus always fails for methods with signature containing array of strings ({{bug |311896}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|PySolFC (And possibly other Tkinter and Tk programs), after moving window, put the menu at the original menu position. ({{bug |312346}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|wish: kwin option to save vertical space: merge window buttons into menu-bar ({{bug |312900}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Checkboxes with bad usability in System settings -> Window behavior -> Moving ({{bug |313228}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|unloading of "Mouse Click Animation" result in kwin crash ({{bug |313655}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Typo in compact/contents/ui/main.qml ({{bug |313950}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add screen management actions to window context menus ({{bug |269207}}, Review 106065)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Move Workspace's compositing functionality to own class Compositor ({{bug |299277}}, Review 102420)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Option to disable close on double click in Aurorae ({{bug |301327}}, Review 106160)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Remove Tiling Support From KWin ({{bug |303090}}, Review 105546)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Allow Scripts to add menus to useractions menu ({{bug |303756}}, Review 106285)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Generic QML support for Aurorae Themes ({{bug |303810}}, Review 105768)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Split out Useractions Menu from Workspace ({{bug |305832}}, Review 106085)|mgraesslin@kde.org}}

{{FeatureDone|kwin|Implement color correction|skeletk13@gmail.com|Casian Andrei}}
{{FeatureDone|oxygen decoration|Implement ExtendedBorderRegion support, to resize windows outside of their actual borders|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|oxygen style|Implement BlurBehind semi-transparent tooltips when available|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|plasma-wallpapers|Color wallpaper: add listview to display thumbnails for background mode|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureDone|plasma workspace|Port Notifications applet to QML|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureDone|System Tray|System tray with interface in QML|dmitry.ashkadov@gmail.com|Dmitry Ashkadov}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|systemsettings|Keyboard layout preview|amourphious1992@gmail.com|Shivam Makkar}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|powerdevil|Overhaul powerdevil notifications|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Split into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureTodo|FolderView|Port to QML|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureDone|Dolphin|Implement parallel sort algorithm|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}
{{FeatureDone|Dolphin|Add GUI option for the "Rename Inline" setting|frank78ac@googlemail.com|Frank Reininghaus}}
{{FeatureDone|Dolphin|Add "Icon Size" submenu to the Places Panel context menu|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|print-manager|New Print manager KCM and applet (plasmoid) replacement, using C++ |dantti12@gmail.com|Daniel Nicoletti}}

{{FeatureDone|Kate|Support for Python plugins|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Advanced gid(1) plugin using both ID files and etags|srhaque@theiet.org|Shaheed Haque}}
{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Built-in quick open (Ctrl+Alt+o)|kwrite-devel@kde.org|Christoph Cullmann}}
{{FeatureDone|Kate|[http://kate-editor.org/2012/11/02/using-the-projects-plugin-in-kate/ New Project Plugin]|kwrite-devel@kde.org|Christoph Cullmann}}
{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/06/passive-notifications-in-kate-part/ Passive Notification System]|kwrite-devel@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/05/loading-remote-files/ Loading Remote File Notification]|kwrite-devel@kde.org|Christoph Cullmann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/10/28/show-line-while-scrolling/ Show line while scrolling]|kwrite-devel@kde.org|D. Haumann/J. Wenninger}}
{{FeatureDone|Kate Part|[http://kate-editor.org/2012/10/27/remove-trailing-spaces/ Improved remove trailing spaces on save]|kwrite-devel@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/07/default-color-schemas/ Predefined color schemes]|kwrite-devel@kde.org|C. Cullmann/D. Haumann}}
{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/06/kate-scripting-updates-zen-like-quick-coding/ Improved Scripting Support]|kwrite-devel@kde.org|C. Cullmann/D. Haumann}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureDone|Konsole|Provde a GUI option to disable requiring CTRL to Drag-n-Drop text|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add initial support for gathering OpenBSD's process information|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add support for xterm's 1006 mouse extension|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add KDE3 print screen functionality|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add KDE3 send signals functionality|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add option to change the line spacing|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureDone|Konsole|Add the ability to clear command line before using bookmarks for some commands|kurt.hindenburg@gmail.com|Kurt Hindenburg}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konqueror|Settings for WebKit Part|sandfeld@kde.org|Allan Sandfeld}}
|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Rocs|Improve project handling: load/save dialogs, add project journal.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Support TGF (trivial graph format) documents for import/export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Support core features for DOT/Graphvis documents for import/export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Add TikZ/PGF graphic export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Main Window UI Reorganization: Editor Toolbar, dialogs, Information Panel|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Configuration Dialog Optimizations: Code-Editor, Graph Editor|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|KTouch|Ship ktouch/next|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Smart resizing of training screen with aligned vertical lines|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Prominent hint during training if the user makes repeatedly errors|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show course descriptions in course selector|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show a message when keyboard layout visualization isn't available due missing data|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|Analitza|New plotting framework|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureDone|KAlgebra|Splitted the QML Components from KAlgebraMobile|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|New plotting plasmoid graphs, in QtQuick|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|Pairs|Pairs Theme editor|marco.calignano@gmail.com|Marco Calignano}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Mark right angles|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|libkdegames|[http://community.kde.org/KDE_Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|KGoldrunner|Use KGameRenderer and QGraphicsView for all graphics: the gameplay is the same as before.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Remove the status bar. All scores and status messages are in the viewport now.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Allow the displayed speed of moves to be adjusted.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Animate multi-stage moves, to make it easier for a human player to follow their progress.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Show multi-stage moves in an order that is easier to follow.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Validate the loading of saved games and report errors.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Rewrite the main AI class and make it use a true Minimax method.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide a choice of two AI styles, Kepler and Newton, with the possibility to add more.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add settings to choose computer player, AI style and skill level for either or both of players 1 and 2.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add board sizes 3x3 and 4x4, for simplified play.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add a simple Print facility for KSudoku puzzles.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|Picmi|Add new game, Picmi: A nonogram logic game for KDE. |jakob.gruber@gmail.com|Jakob Gruber}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}
{{FeatureDone|okular|Tiled rendering|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Active based UI|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|PDF Embedded Video improvements|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Make document scroll as necessary when in text selection mode|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Support high precision QTabletEvents for creating annotations|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Additional mouse buttons trigger history navigation|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Annotation editing improvements|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|Gwenview|Recursive importer|agateau@kde.org|Aurélien Gâteau}}
{{FeatureDone|Gwenview|Color profile support|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add lyrics view|martin.sandsmark@kde.org|Martin Sandsmark}}

|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KGet|Metalink/HTTP Support|dahalaishraj@gmail.com|Aish Raj Dahal}}

|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureDone|KAlarm|Add command line and D-Bus option to output list of scheduled alarms|djarvie@kde.org|David Jarvie}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
{{FeatureDone|ComicStrip|Replace with QML version|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureDone|Calculator|Replace with QML version|luizromario@gmail.com|Luiz Romário Santana Rios}}
{{FeatureDone|QML Wallpapers|Make it possible to have animated wallpapers written in QtQuick technologies.|aleixpol@blue-systems.com|Aleix Pol Gonzalez}}
{{FeatureDone|Dictionary KRunner|Look up words in the dictionary by typing in 'define {word}' in krunner. [http://blog.zx2c4.com/808 Blog]|Jason@zx2c4.com|Jason A. Donenfeld}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add tagged unions to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add array indices to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Umbrello|Line based diagram grid |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello| widget resize and diagram auto resize feature |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello|add spline based association lines to avoid autolayout widget/line overlapping (needs volunteers)|ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
|}

Development/Tutorials/KWin/Scripting/API 4.9

2013-01-11T22:31:47Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
* ''object'' '''KWin''': Provides access to enums defined in KWin::WorkspaceWrapper
=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* '''callDBus(QString service, QString path, QString interface, QString method, QVariant arg..., QScriptValue callback = QScriptValue())''': Call a D-Bus method at (service, path, interface and method). A variable number of arguments can be added to the method call. The D-Bus call is always performed in an async way invoking the callback provided as the last (optional) argument. The reply values of the D-Bus method call are passed to the callback.
* '''registerUserActionsMenu(QScriptValue callback)''': 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*/}

== KWin::WorkspaceWrapper ==

=== Enums ===

==== ClientAreaOption ====

* '''PlacementArea''': window movement snapping area? ignore struts
* '''MovementArea''':
* '''MaximizeArea''':
* '''MaximizeFullArea''':
* '''FullScreenArea''':
* '''WorkArea''':
* '''FullArea''':
* '''ScreenArea''':
==== ElectricBorder ====

* '''ElectricTop''':
* '''ElectricTopRight''':
* '''ElectricRight''':
* '''ElectricBottomRight''':
* '''ElectricBottom''':
* '''ElectricBottomLeft''':
* '''ElectricLeft''':
* '''ElectricTopLeft''':
* '''ELECTRIC_COUNT''':
* '''ElectricNone''':
=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''QString'' '''currentActivity'''
* ''QStringList'' '''activities'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop, KWin::Client *client)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
* '''currentActivityChanged(const QString &id)''': Signal emitted whenever the current activity changed. id id of the new activity
* '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Enums ===

==== FocusPolicy ====

* '''ClickToFocus''':
* '''FocusFollowsMouse''':
* '''FocusUnderMouse''':
* '''FocusStrictlyUnderMouse''':
==== MouseCommand ====

* '''MouseRaise''':
* '''MouseLower''':
* '''MouseOperationsMenu''':
* '''MouseToggleRaiseAndLower''':
* '''MouseActivateAndRaise''':
* '''MouseActivateAndLower''':
* '''MouseActivate''':
* '''MouseActivateRaiseAndPassClick''':
* '''MouseActivateAndPassClick''':
* '''MouseMove''':
* '''MouseUnrestrictedMove''':
* '''MouseActivateRaiseAndMove''':
* '''MouseActivateRaiseAndUnrestrictedMove''':
* '''MouseResize''':
* '''MouseUnrestrictedResize''':
* '''MouseShade''':
* '''MouseSetShade''':
* '''MouseUnsetShade''':
* '''MouseMaximize''':
* '''MouseRestore''':
* '''MouseMinimize''':
* '''MouseNextDesktop''':
* '''MousePreviousDesktop''':
* '''MouseAbove''':
* '''MouseBelow''':
* '''MouseOpacityMore''':
* '''MouseOpacityLess''':
* '''MouseClose''':
* '''MousePreviousTab''':
* '''MouseNextTab''':
* '''MouseDragTab''':
* '''MouseNothing''':
==== MouseWheelCommand ====

* '''MouseWheelRaiseLower''':
* '''MouseWheelShadeUnshade''':
* '''MouseWheelMaximizeRestore''':
* '''MouseWheelAboveBelow''':
* '''MouseWheelPreviousNextDesktop''':
* '''MouseWheelChangeOpacity''':
* '''MouseWheelChangeCurrentTab''':
* '''MouseWheelNothing''':
==== @16 ====

* '''ElectricDisabled''':
* '''ElectricMoveOnly''':
* '''ElectricAlways''':
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''float'' '''electricBorderCornerRatio''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''uint'' '''vBlankTime'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
* ''bool'' '''glStrictBindingFollowsDriver''': Whether strict binding follows the driver or has been overwritten by a user defined config value. If true is set by the OpenGL Scene during initialization. If false glStrictBinding is set from a config value and not updated during scene initialization.
* ''bool'' '''glLegacy''': Whether legacy OpenGL should be used or OpenGL (ES) 2
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''electricBorderCornerRatioChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''vBlankTimeChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
* '''glStrictBindingFollowsDriverChanged()'''
* '''glLegacyChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''QRect'' '''visibleRect'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''paddingChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
* '''needsRepaint()''': Emitted whenever the state changes in a way, that the Compositor should schedule a repaint of the scene.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Enums ===

==== Sizemode ====

* '''SizemodeAny''':
* '''SizemodeFixedW''':
* '''SizemodeFixedH''':
* '''SizemodeMax''':
==== CoordinateMode ====

* '''DecorationRelative''':
* '''WindowRelative''':
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged(KWin::Client *client)''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* '''syncTabGroupFor(QString property, bool fromThisClient=false)''': Syncs the dynamic property fromThisClient or the to all members of the tabGroup() (if there is one) eg. if you call: client->setProperty("kwin_tiling_floats", true); client->syncTabGroupFor("kwin_tiling_floats", true) all clients in this tabGroup will have ::property("kwin_tiling_floats").toBool() == true WARNING: non dynamic properties are ignored - you're not supposed to alter/update such explicitly
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Effects/JS API

2012-11-09T08:30:14Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects
* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect
* ''object'' '''Effect''': Provides access to enums defined in KWin::AnimationEffect and KWin::ScriptedEffect
* ''object'' '''KWin''': Provides access to enums defined in KWin::WorkspaceWrapper
=== Functions ===

* '''animate(settings)''': Schedules one or many animations for one window. The animations are defined through the settings object providing
a more declarative way to specify the animations than the animate call on the effect object. The settings object
supports the following attributes:
<syntaxhighlight lang="javascript">
{
window: EffectWindow, /* the window to animate, required */
duration: int, /* duration in msec, required */
curve: QEasingCurve.Type, /* global easing curve, optional */
type: Effect.Attribute, /* for first animation, optional */
from: FPx2, /* for first animation, optional */
to: FPx2, /* for first animation, optional */
delay: int, /* for first animation, optional */
animations: [ /* additional animations, optional */
{
curve: QEasingCurve.Type, /* overrides global */
type: Effect.Attribute,
from: FPx2,
to: FPx2,
delay: int
}
]
}
</syntaxhighlight>
At least one animation needs to be specified either with the top-level properties or in the animations list.
* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''int'' '''animationTime(int duration)''': Adjusts the passed in duration to the global animation time facator.
* ''int'' '''displayWidth()''': Width of the complete display (all screens).
* ''int'' '''displayHeight()''': Height of the complete display (all screens).
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::FPx2 ==
This class is used to describe the animation end points, that is from which FPx2 values to which FPx2 values an animation goes. This class contains two properties to describe two animation components individually (e.g. width and height). But it's also possible to just have one value (e.g. opacity). In this case the definition of an FPx2 can be replaced by a single value.
=== Read-write Properties ===

* ''qreal'' '''value1'''
* ''qreal'' '''value2'''
=== Functions ===

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed.

oldDesktop

The previously current desktop

newDesktop

The new current desktop

with

The window which is taken over to the new desktop, can be NULL

4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7
Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed.

old

The previous number of desktops in used.

EffectsHandler::numberOfDesktops.
4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace.

w

The added window

4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated.

w

The new active window, or NULL if there is no active window.

4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references.

w

The window which is going to be deleted.

EffectWindow::refWindow EffectWindow::unrefWindow windowClosed
4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window.

w

The window which is being moved/resized

geometry

The geometry of the window in the current move/resize step.

windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize
4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w.

w

The window which has been moved/resized

windowStartUserMovedResized windowFinishUserMovedResized
4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states:
restored: both horizontal and vertical are false
horizontally maximized: horizontal is true and vertical is false
vertically maximized: horizontal is false and vertical is true
completely maximized: both horizontal and vertical are true

w

The window whose maximized state changed

horizontal

If true maximized horizontally

vertical

If true maximized vertically

4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction.

w

The window whose geometry changed

old

The previous geometry

windowUserMovedResized
4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size)

w

The window whose geometry changed

old

The previous expandedGeometry()

4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed.

w

The window whose opacity level is changed.

oldOpacity

The previous opacity level

newOpacity

The new opacity level

4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized.

w

The window which was minimized

4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized.

w

The window which was unminimized

4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well.

w

The window which is scheduled for repainting

r

Always empty.

4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline
4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches.

size

The new screen size

4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed

id

id of the new current activity

4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added

id

id of the new activity

4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed

id

id of the removed activity

4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Enums ===

==== @15 ====

* '''PAINT_DISABLED''': Window will not be painted
* '''PAINT_DISABLED_BY_DELETE''': Window will not be painted because it is deleted
* '''PAINT_DISABLED_BY_DESKTOP''': Window will not be painted because of which desktop it's on
* '''PAINT_DISABLED_BY_MINIMIZE''': Window will not be painted because it is minimized
* '''PAINT_DISABLED_BY_TAB_GROUP''': Window will not be painted because it is not the active window in a client group
* '''PAINT_DISABLED_BY_ACTIVITY''': Window will not be painted because it's not on the current activity
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationEffect ==

'''Inherits:''' KWin::Effect
=== Enums ===

==== Anchor ====

* '''Left''':
* '''Top''':
* '''Right''':
* '''Bottom''':
* '''Horizontal''':
* '''Vertical''':
* '''Mouse''':
==== Attribute ====

* '''Opacity''':
* '''Brightness''':
* '''Saturation''':
* '''Scale''':
* '''Rotation''':
* '''Position''':
* '''Size''':
* '''Translation''':
* '''Clip''':
* '''Generic''':
* '''NonFloatBase''':
==== MetaType ====

* '''SourceAnchor''':
* '''TargetAnchor''':
* '''RelativeSourceX''':
* '''RelativeSourceY''':
* '''RelativeTargetX''':
* '''RelativeTargetY''':
* '''Axis''':
=== Functions ===

== KWin::AnimationData ==

=== Enums ===

==== Axis ====

* '''XAxis''':
* '''YAxis''':
* '''ZAxis''':
=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect
=== Enums ===

==== DataRole ====

* '''WindowAddedGrabRole''':
* '''WindowClosedGrabRole''':
* '''WindowMinimizedGrabRole''':
* '''WindowUnminimizedGrabRole''':
* '''WindowForceBlurRole''':
* '''WindowBlurBehindRole''':
* '''LanczosCacheRole''':
=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole.

w

The window to check

grabRole

The grab role to check

true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key.

key

The key to search for

defaultValue

The value to return if the key is not found

The config value if present

Development/Tutorials/KWin/Effects/JS API

2012-10-28T10:01:03Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects
* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect
* ''object'' '''Effect''': Provides access to enums defined in KWin::AnimationEffect and KWin::ScriptedEffect
* ''object'' '''KWin''': Provides access to enums defined in KWin::WorkspaceWrapper
=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''int'' '''animationTime(int duration)''': Adjusts the passed in duration to the global animation time facator.
* ''int'' '''displayWidth()''': Width of the complete display (all screens).
* ''int'' '''displayHeight()''': Height of the complete display (all screens).
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::FPx2 ==
This class is used to describe the animation end points, that is from which FPx2 values to which FPx2 values an animation goes. This class contains two properties to describe two animation components individually (e.g. width and height). But it's also possible to just have one value (e.g. opacity). In this case the definition of an FPx2 can be replaced by a single value.
=== Read-write Properties ===

* ''qreal'' '''value1'''
* ''qreal'' '''value2'''

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed. oldDesktop The previously current desktop newDesktop The new current desktop with The window which is taken over to the new desktop, can be NULL 4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7 Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed. old The previous number of desktops in used. EffectsHandler::numberOfDesktops. 4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace. w The added window 4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated. w The new active window, or NULL if there is no active window. 4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references. w The window which is going to be deleted. EffectWindow::refWindow EffectWindow::unrefWindow windowClosed 4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window. w The window which is being moved/resized geometry The geometry of the window in the current move/resize step. windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w. w The window which has been moved/resized windowStartUserMovedResized windowFinishUserMovedResized 4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states: restored: both horizontal and vertical are false horizontally maximized: horizontal is true and vertical is false vertically maximized: horizontal is false and vertical is true completely maximized: both horizontal and vertical are true w The window whose maximized state changed horizontal If true maximized horizontally vertical If true maximized vertically 4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction. w The window whose geometry changed old The previous geometry windowUserMovedResized 4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size) w The window whose geometry changed old The previous expandedGeometry() 4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed. w The window whose opacity level is changed. oldOpacity The previous opacity level newOpacity The new opacity level 4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized. w The window which was minimized 4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized. w The window which was unminimized 4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well. w The window which is scheduled for repainting r The damaged rect 4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline 4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches. size The new screen size 4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed id id of the new current activity 4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity 4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity 4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Enums ===

==== @15 ====

* '''PAINT_DISABLED''': Window will not be painted
* '''PAINT_DISABLED_BY_DELETE''': Window will not be painted because it is deleted
* '''PAINT_DISABLED_BY_DESKTOP''': Window will not be painted because of which desktop it's on
* '''PAINT_DISABLED_BY_MINIMIZE''': Window will not be painted because it is minimized
* '''PAINT_DISABLED_BY_TAB_GROUP''': Window will not be painted because it is not the active window in a client group
* '''PAINT_DISABLED_BY_ACTIVITY''': Window will not be painted because it's not on the current activity
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationEffect ==

'''Inherits:''' KWin::Effect
=== Enums ===

==== Anchor ====

* '''Left''':
* '''Top''':
* '''Right''':
* '''Bottom''':
* '''Horizontal''':
* '''Vertical''':
* '''Mouse''':
==== Attribute ====

* '''Opacity''':
* '''Brightness''':
* '''Saturation''':
* '''Scale''':
* '''Rotation''':
* '''Position''':
* '''Size''':
* '''Translation''':
* '''Clip''':
* '''Generic''':
* '''NonFloatBase''':
==== MetaType ====

* '''SourceAnchor''':
* '''TargetAnchor''':
* '''RelativeSourceX''':
* '''RelativeSourceY''':
* '''RelativeTargetX''':
* '''RelativeTargetY''':
* '''Axis''':
=== Functions ===

== KWin::AnimationData ==

=== Enums ===

==== Axis ====

* '''XAxis''':
* '''YAxis''':
* '''ZAxis''':
=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect
=== Enums ===

==== DataRole ====

* '''WindowAddedGrabRole''':
* '''WindowClosedGrabRole''':
* '''WindowMinimizedGrabRole''':
* '''WindowUnminimizedGrabRole''':
* '''WindowForceBlurRole''':
* '''WindowBlurBehindRole''':
* '''LanczosCacheRole''':
=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole. w The window to check grabRole The grab role to check true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key. key The key to search for defaultValue The value to return if the key is not found The config value if present

Development/Tutorials/KWin/Scripting/API 4.9

2012-10-28T09:33:26Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* '''callDBus(QString service, QString path, QString interface, QString method, QVariant arg..., QScriptValue callback = QScriptValue())''': Call a D-Bus method at (service, path, interface and method). A variable number of arguments can be added to the method call. The D-Bus call is always performed in an async way invoking the callback provided as the last (optional) argument. The reply values of the D-Bus method call are passed to the callback.
* '''registerUserActionsMenu(QScriptValue callback)''': 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*/}

== KWin::WorkspaceWrapper ==

=== Enums ===

==== ClientAreaOption ====

* '''PlacementArea''': window movement snapping area? ignore struts
* '''MovementArea''':
* '''MaximizeArea''':
* '''MaximizeFullArea''':
* '''FullScreenArea''':
* '''WorkArea''':
* '''FullArea''':
* '''ScreenArea''':
==== ElectricBorder ====

* '''ElectricTop''':
* '''ElectricTopRight''':
* '''ElectricRight''':
* '''ElectricBottomRight''':
* '''ElectricBottom''':
* '''ElectricBottomLeft''':
* '''ElectricLeft''':
* '''ElectricTopLeft''':
* '''ELECTRIC_COUNT''':
* '''ElectricNone''':
=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''QString'' '''currentActivity'''
* ''QStringList'' '''activities'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop, KWin::Client *client)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
* '''currentActivityChanged(const QString &id)''': Signal emitted whenever the current activity changed. id id of the new activity
* '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Enums ===

==== FocusPolicy ====

* '''ClickToFocus''':
* '''FocusFollowsMouse''':
* '''FocusUnderMouse''':
* '''FocusStrictlyUnderMouse''':
==== MouseCommand ====

* '''MouseRaise''':
* '''MouseLower''':
* '''MouseOperationsMenu''':
* '''MouseToggleRaiseAndLower''':
* '''MouseActivateAndRaise''':
* '''MouseActivateAndLower''':
* '''MouseActivate''':
* '''MouseActivateRaiseAndPassClick''':
* '''MouseActivateAndPassClick''':
* '''MouseMove''':
* '''MouseUnrestrictedMove''':
* '''MouseActivateRaiseAndMove''':
* '''MouseActivateRaiseAndUnrestrictedMove''':
* '''MouseResize''':
* '''MouseUnrestrictedResize''':
* '''MouseShade''':
* '''MouseSetShade''':
* '''MouseUnsetShade''':
* '''MouseMaximize''':
* '''MouseRestore''':
* '''MouseMinimize''':
* '''MouseNextDesktop''':
* '''MousePreviousDesktop''':
* '''MouseAbove''':
* '''MouseBelow''':
* '''MouseOpacityMore''':
* '''MouseOpacityLess''':
* '''MouseClose''':
* '''MousePreviousTab''':
* '''MouseNextTab''':
* '''MouseDragTab''':
* '''MouseNothing''':
==== MouseWheelCommand ====

* '''MouseWheelRaiseLower''':
* '''MouseWheelShadeUnshade''':
* '''MouseWheelMaximizeRestore''':
* '''MouseWheelAboveBelow''':
* '''MouseWheelPreviousNextDesktop''':
* '''MouseWheelChangeOpacity''':
* '''MouseWheelChangeCurrentTab''':
* '''MouseWheelNothing''':
==== @16 ====

* '''ElectricDisabled''':
* '''ElectricMoveOnly''':
* '''ElectricAlways''':
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''float'' '''electricBorderCornerRatio''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''uint'' '''vBlankTime'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
* ''bool'' '''glStrictBindingFollowsDriver''': Whether strict binding follows the driver or has been overwritten by a user defined config value. If true is set by the OpenGL Scene during initialization. If false glStrictBinding is set from a config value and not updated during scene initialization.
* ''bool'' '''glLegacy''': Whether legacy OpenGL should be used or OpenGL (ES) 2
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''electricBorderCornerRatioChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''vBlankTimeChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
* '''glStrictBindingFollowsDriverChanged()'''
* '''glLegacyChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''QRect'' '''visibleRect'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''paddingChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
* '''needsRepaint()''': Emitted whenever the state changes in a way, that the Compositor should schedule a repaint of the scene.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Enums ===

==== Sizemode ====

* '''SizemodeAny''':
* '''SizemodeFixedW''':
* '''SizemodeFixedH''':
* '''SizemodeMax''':
==== CoordinateMode ====

* '''DecorationRelative''':
* '''WindowRelative''':
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged(KWin::Client *client)''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* '''syncTabGroupFor(QString property, bool fromThisClient=false)''': Syncs the dynamic property fromThisClient or the to all members of the tabGroup() (if there is one) eg. if you call: client->setProperty("kwin_tiling_floats", true); client->syncTabGroupFor("kwin_tiling_floats", true) all clients in this tabGroup will have ::property("kwin_tiling_floats").toBool() == true WARNING: non dynamic properties are ignored - you're not supposed to alter/update such explicitly
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-10-27T18:14:59Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* '''callDBus(QString service, QString path, QString interface, QString method, QVariant arg..., QScriptValue callback = QScriptValue())''': Call a D-Bus method at (service, path, interface and method). A variable number of arguments can be added to the method call. The D-Bus call is always performed in an async way invoking the callback provided as the last (optional) argument. The reply values of the D-Bus method call are passed to the callback.
* '''QScriptValue callback''': 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*/}

== KWin::WorkspaceWrapper ==

=== Enums ===

==== ClientAreaOption ====

* '''PlacementArea''': window movement snapping area? ignore struts
* '''MovementArea''':
* '''MaximizeArea''':
* '''MaximizeFullArea''':
* '''FullScreenArea''':
* '''WorkArea''':
* '''FullArea''':
* '''ScreenArea''':
==== ElectricBorder ====

* '''ElectricTop''':
* '''ElectricTopRight''':
* '''ElectricRight''':
* '''ElectricBottomRight''':
* '''ElectricBottom''':
* '''ElectricBottomLeft''':
* '''ElectricLeft''':
* '''ElectricTopLeft''':
* '''ELECTRIC_COUNT''':
* '''ElectricNone''':
=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''QString'' '''currentActivity'''
* ''QStringList'' '''activities'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop, KWin::Client *client)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
* '''currentActivityChanged(const QString &id)''': Signal emitted whenever the current activity changed. id id of the new activity
* '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Enums ===

==== FocusPolicy ====

* '''ClickToFocus''':
* '''FocusFollowsMouse''':
* '''FocusUnderMouse''':
* '''FocusStrictlyUnderMouse''':
==== MouseCommand ====

* '''MouseRaise''':
* '''MouseLower''':
* '''MouseOperationsMenu''':
* '''MouseToggleRaiseAndLower''':
* '''MouseActivateAndRaise''':
* '''MouseActivateAndLower''':
* '''MouseActivate''':
* '''MouseActivateRaiseAndPassClick''':
* '''MouseActivateAndPassClick''':
* '''MouseMove''':
* '''MouseUnrestrictedMove''':
* '''MouseActivateRaiseAndMove''':
* '''MouseActivateRaiseAndUnrestrictedMove''':
* '''MouseResize''':
* '''MouseUnrestrictedResize''':
* '''MouseShade''':
* '''MouseSetShade''':
* '''MouseUnsetShade''':
* '''MouseMaximize''':
* '''MouseRestore''':
* '''MouseMinimize''':
* '''MouseNextDesktop''':
* '''MousePreviousDesktop''':
* '''MouseAbove''':
* '''MouseBelow''':
* '''MouseOpacityMore''':
* '''MouseOpacityLess''':
* '''MouseClose''':
* '''MousePreviousTab''':
* '''MouseNextTab''':
* '''MouseDragTab''':
* '''MouseNothing''':
==== MouseWheelCommand ====

* '''MouseWheelRaiseLower''':
* '''MouseWheelShadeUnshade''':
* '''MouseWheelMaximizeRestore''':
* '''MouseWheelAboveBelow''':
* '''MouseWheelPreviousNextDesktop''':
* '''MouseWheelChangeOpacity''':
* '''MouseWheelChangeCurrentTab''':
* '''MouseWheelNothing''':
==== @16 ====

* '''ElectricDisabled''':
* '''ElectricMoveOnly''':
* '''ElectricAlways''':
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''float'' '''electricBorderCornerRatio''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''uint'' '''vBlankTime'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
* ''bool'' '''glStrictBindingFollowsDriver''': Whether strict binding follows the driver or has been overwritten by a user defined config value. If true is set by the OpenGL Scene during initialization. If false glStrictBinding is set from a config value and not updated during scene initialization.
* ''bool'' '''glLegacy''': Whether legacy OpenGL should be used or OpenGL (ES) 2
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''electricBorderCornerRatioChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''vBlankTimeChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
* '''glStrictBindingFollowsDriverChanged()'''
* '''glLegacyChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''QRect'' '''visibleRect'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''paddingChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
* '''needsRepaint()''': Emitted whenever the state changes in a way, that the Compositor should schedule a repaint of the scene.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Enums ===

==== Sizemode ====

* '''SizemodeAny''':
* '''SizemodeFixedW''':
* '''SizemodeFixedH''':
* '''SizemodeMax''':
==== CoordinateMode ====

* '''DecorationRelative''':
* '''WindowRelative''':
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged(KWin::Client *client)''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* '''syncTabGroupFor(QString property, bool fromThisClient=false)''': Syncs the dynamic property fromThisClient or the to all members of the tabGroup() (if there is one) eg. if you call: client->setProperty("kwin_tiling_floats", true); client->syncTabGroupFor("kwin_tiling_floats", true) all clients in this tabGroup will have ::property("kwin_tiling_floats").toBool() == true WARNING: non dynamic properties are ignored - you're not supposed to alter/update such explicitly
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Effects/JS API

2012-10-27T18:10:18Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects
* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''int'' '''animationTime(int duration)''': Adjusts the passed in duration to the global animation time facator.
* ''int'' '''displayWidth()''': Width of the complete display (all screens).
* ''int'' '''displayHeight()''': Height of the complete display (all screens).
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed. oldDesktop The previously current desktop newDesktop The new current desktop with The window which is taken over to the new desktop, can be NULL 4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7 Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed. old The previous number of desktops in used. EffectsHandler::numberOfDesktops. 4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace. w The added window 4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated. w The new active window, or NULL if there is no active window. 4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references. w The window which is going to be deleted. EffectWindow::refWindow EffectWindow::unrefWindow windowClosed 4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window. w The window which is being moved/resized geometry The geometry of the window in the current move/resize step. windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w. w The window which has been moved/resized windowStartUserMovedResized windowFinishUserMovedResized 4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states: restored: both horizontal and vertical are false horizontally maximized: horizontal is true and vertical is false vertically maximized: horizontal is false and vertical is true completely maximized: both horizontal and vertical are true w The window whose maximized state changed horizontal If true maximized horizontally vertical If true maximized vertically 4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction. w The window whose geometry changed old The previous geometry windowUserMovedResized 4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size) w The window whose geometry changed old The previous expandedGeometry() 4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed. w The window whose opacity level is changed. oldOpacity The previous opacity level newOpacity The new opacity level 4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized. w The window which was minimized 4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized. w The window which was unminimized 4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well. w The window which is scheduled for repainting r The damaged rect 4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline 4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches. size The new screen size 4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed id id of the new current activity 4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity 4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity 4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Enums ===

==== @15 ====

* '''PAINT_DISABLED''': Window will not be painted
* '''PAINT_DISABLED_BY_DELETE''': Window will not be painted because it is deleted
* '''PAINT_DISABLED_BY_DESKTOP''': Window will not be painted because of which desktop it's on
* '''PAINT_DISABLED_BY_MINIMIZE''': Window will not be painted because it is minimized
* '''PAINT_DISABLED_BY_TAB_GROUP''': Window will not be painted because it is not the active window in a client group
* '''PAINT_DISABLED_BY_ACTIVITY''': Window will not be painted because it's not on the current activity
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationEffect ==

'''Inherits:''' KWin::Effect
=== Enums ===

==== Anchor ====

* '''Left''':
* '''Top''':
* '''Right''':
* '''Bottom''':
* '''Horizontal''':
* '''Vertical''':
* '''Mouse''':
==== Attribute ====

* '''Opacity''':
* '''Brightness''':
* '''Saturation''':
* '''Scale''':
* '''Rotation''':
* '''Position''':
* '''Size''':
* '''Translation''':
* '''Clip''':
* '''Generic''':
* '''NonFloatBase''':
==== MetaType ====

* '''SourceAnchor''':
* '''TargetAnchor''':
* '''RelativeSourceX''':
* '''RelativeSourceY''':
* '''RelativeTargetX''':
* '''RelativeTargetY''':
* '''Axis''':
=== Functions ===

== KWin::AnimationData ==

=== Enums ===

==== Axis ====

* '''XAxis''':
* '''YAxis''':
* '''ZAxis''':
=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect
=== Enums ===

==== DataRole ====

* '''WindowAddedGrabRole''':
* '''WindowClosedGrabRole''':
* '''WindowMinimizedGrabRole''':
* '''WindowUnminimizedGrabRole''':
* '''WindowForceBlurRole''':
* '''WindowBlurBehindRole''':
* '''LanczosCacheRole''':
=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole. w The window to check grabRole The grab role to check true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key. key The key to search for defaultValue The value to return if the key is not found The config value if present

Development/Tutorials/KWin/Effects/JS API

2012-10-27T17:35:47Z

Mgraesslin: enums

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects
* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''int'' '''animationTime(int duration)''': Adjusts the passed in duration to the global animation time facator.
* ''int'' '''displayWidth()''': Width of the complete display (all screens).
* ''int'' '''displayHeight()''': Height of the complete display (all screens).
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed. oldDesktop The previously current desktop newDesktop The new current desktop with The window which is taken over to the new desktop, can be NULL 4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7 Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed. old The previous number of desktops in used. EffectsHandler::numberOfDesktops. 4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace. w The added window 4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated. w The new active window, or NULL if there is no active window. 4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references. w The window which is going to be deleted. EffectWindow::refWindow EffectWindow::unrefWindow windowClosed 4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window. w The window which is being moved/resized geometry The geometry of the window in the current move/resize step. windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w. w The window which has been moved/resized windowStartUserMovedResized windowFinishUserMovedResized 4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states: restored: both horizontal and vertical are false horizontally maximized: horizontal is true and vertical is false vertically maximized: horizontal is false and vertical is true completely maximized: both horizontal and vertical are true w The window whose maximized state changed horizontal If true maximized horizontally vertical If true maximized vertically 4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction. w The window whose geometry changed old The previous geometry windowUserMovedResized 4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size) w The window whose geometry changed old The previous expandedGeometry() 4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed. w The window whose opacity level is changed. oldOpacity The previous opacity level newOpacity The new opacity level 4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized. w The window which was minimized 4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized. w The window which was unminimized 4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well. w The window which is scheduled for repainting r The damaged rect 4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline 4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches. size The new screen size 4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed id id of the new current activity 4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity 4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity 4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Signals ===

=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationEffect ==

'''Inherits:''' KWin::Effect
=== Enums ===

==== Anchor ====

* '''Left''':
* '''Top''':
* '''Right''':
* '''Bottom''':
* '''Horizontal''':
* '''Vertical''':
* '''Mouse''':
==== Attribute ====

* '''Opacity''':
* '''Brightness''':
* '''Saturation''':
* '''Scale''':
* '''Rotation''':
* '''Position''':
* '''Size''':
* '''Translation''':
* '''Clip''':
* '''Generic''':
* '''NonFloatBase''':
==== MetaType ====

* '''SourceAnchor''':
* '''TargetAnchor''':
* '''RelativeSourceX''':
* '''RelativeSourceY''':
* '''RelativeTargetX''':
* '''RelativeTargetY''':
* '''Axis''':
=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

=== Functions ===

== KWin::AnimationData ==
=== Enums ===

==== Axis ====

* '''XAxis''':
* '''YAxis''':
* '''ZAxis''':

=== Read-only Properties ===

=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Signals ===

=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect

=== Enums ===

==== DataRole ====

* '''WindowAddedGrabRole''':
* '''WindowClosedGrabRole''':
* '''WindowMinimizedGrabRole''':
* '''WindowUnminimizedGrabRole''':
* '''WindowForceBlurRole''':
* '''WindowBlurBehindRole''':
* '''LanczosCacheRole''':
=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole. w The window to check grabRole The grab role to check true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key. key The key to search for defaultValue The value to return if the key is not found The config value if present

Development/Tutorials/KWin/Effects/JS API

2012-10-27T16:55:08Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects
* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''int'' '''animationTime(int duration)''': Adjusts the passed in duration to the global animation time facator.
* ''int'' '''displayWidth()''': Width of the complete display (all screens).
* ''int'' '''displayHeight()''': Height of the complete display (all screens).
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed. oldDesktop The previously current desktop newDesktop The new current desktop with The window which is taken over to the new desktop, can be NULL 4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7 Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed. old The previous number of desktops in used. EffectsHandler::numberOfDesktops. 4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace. w The added window 4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated. w The new active window, or NULL if there is no active window. 4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references. w The window which is going to be deleted. EffectWindow::refWindow EffectWindow::unrefWindow windowClosed 4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window. w The window which is being moved/resized geometry The geometry of the window in the current move/resize step. windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w. w The window which has been moved/resized windowStartUserMovedResized windowFinishUserMovedResized 4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states: restored: both horizontal and vertical are false horizontally maximized: horizontal is true and vertical is false vertically maximized: horizontal is false and vertical is true completely maximized: both horizontal and vertical are true w The window whose maximized state changed horizontal If true maximized horizontally vertical If true maximized vertically 4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction. w The window whose geometry changed old The previous geometry windowUserMovedResized 4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size) w The window whose geometry changed old The previous expandedGeometry() 4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed. w The window whose opacity level is changed. oldOpacity The previous opacity level newOpacity The new opacity level 4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized. w The window which was minimized 4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized. w The window which was unminimized 4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well. w The window which is scheduled for repainting r The damaged rect 4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline 4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches. size The new screen size 4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed id id of the new current activity 4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity 4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity 4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Signals ===

=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationData ==

=== Read-only Properties ===

=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Signals ===

=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect
=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole. w The window to check grabRole The grab role to check true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key. key The key to search for defaultValue The value to return if the key is not found The config value if present

Development/Tutorials/KWin/Effects/JS API

2012-10-26T14:19:19Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::ScriptedEffect'' '''effect''': Global property to the actual Effect.
* ''KWin::EffectsHandler'' '''effects''': Global property to the core wrapper of KWin Effects.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

== KWin::EffectsHandler ==
Manager class that handles all the effects.
=== Read-only Properties ===

* ''QString'' '''currentActivity'''
* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''bool'' '''optionRollOverDesktops'''
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''qreal'' '''animationTimeFactor''': Factor by which animation speed in the effect should be modified (multiplied). If configurable in the effect itself, the option should have also 'default' animation speed. The actual value should be determined using animationTime(). Note: The factor can be also 0, so make sure your code can cope with 0ms time if used manually.
* ''QList< KWin::EffectWindow * >'' '''stackingOrder'''
* ''bool'' '''decorationsHaveAlpha''': Whether window decorations use the alpha channel.
* ''bool'' '''decorationSupportsBlurBehind''': Whether the window decorations support blurring behind the decoration.
* ''CompositingType'' '''compositingType'''
* ''QPoint'' '''cursorPos'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::EffectWindow'' '''activeWindow'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopChanged(int oldDesktop, int newDesktop, KWin::EffectWindow *with)''': Signal emitted when the current desktop changed. oldDesktop The previously current desktop newDesktop The new current desktop with The window which is taken over to the new desktop, can be NULL 4.9
* '''desktopChanged(int oldDesktop, int newDesktop)''': 4.7 Deprecated
* '''numberDesktopsChanged(int old)''': Signal emitted when the number of currently existing desktops is changed. old The previous number of desktops in used. EffectsHandler::numberOfDesktops. 4.7
* '''windowAdded(KWin::EffectWindow *w)''': Signal emitted when a new window has been added to the Workspace. w The added window 4.7
* '''windowClosed(KWin::EffectWindow *w)''': Signal emitted when a window is being removed from the Workspace. An effect which wants to animate the window closing should connect to this signal and reference the window by using w The window which is being closed 4.7
* '''windowActivated(KWin::EffectWindow *w)''': Signal emitted when a window get's activated. w The new active window, or NULL if there is no active window. 4.7
* '''windowDeleted(KWin::EffectWindow *w)''': Signal emitted when a window is deleted. This means that a closed window is not referenced any more. An effect bookkeeping the closed windows should connect to this signal to clean up the internal references. w The window which is going to be deleted. EffectWindow::refWindow EffectWindow::unrefWindow windowClosed 4.7
* '''windowStartUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when a user begins a window move or resize operation. To figure out whether the user resizes or moves the window use or EffectWindow::isUserResize. Whenever the geometry is updated the signal windowStepUserMovedResized is emitted with the current geometry. The move/resize operation ends with the signal windowFinishUserMovedResized. Only one window can be moved/resized by the user at the same time! w The window which is being moved/resized windowStepUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowStepUserMovedResized(KWin::EffectWindow *w, const QRect &geometry)''': Signal emitted during a move/resize operation when the user changed the geometry. Please note: KWin supports two operation modes. In one mode all changes are applied instantly. This means the window's geometry matches the passed in geometry. In the other mode the geometry is changed after the user ended the move/resize mode. The geometry differs from the window's geometry. Also the window's pixmap still has the same size as before. Depending what the effect wants to do it would be recommended to scale/translate the window. w The window which is being moved/resized geometry The geometry of the window in the current move/resize step. windowStartUserMovedResized windowFinishUserMovedResized EffectWindow::isUserMove EffectWindow::isUserResize 4.7
* '''windowFinishUserMovedResized(KWin::EffectWindow *w)''': Signal emitted when the user finishes move/resize of window w. w The window which has been moved/resized windowStartUserMovedResized windowFinishUserMovedResized 4.7
* '''windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical)''': Signal emitted when the maximized state of the window w changed. A window can be in one of four states: restored: both horizontal and vertical are false horizontally maximized: horizontal is true and vertical is false vertically maximized: horizontal is false and vertical is true completely maximized: both horizontal and vertical are true w The window whose maximized state changed horizontal If true maximized horizontally vertical If true maximized vertically 4.7
* '''windowGeometryShapeChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the geometry or shape of a window changed. This is caused if the window changes geometry without user interaction. E.g. the decoration is changed. This is in opposite to windowUserMovedResized which is caused by direct user interaction. w The window whose geometry changed old The previous geometry windowUserMovedResized 4.7
* '''windowPaddingChanged(KWin::EffectWindow *w, const QRect &old)''': Signal emitted when the padding of a window changed. (eg. shadow size) w The window whose geometry changed old The previous expandedGeometry() 4.9
* '''windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity)''': Signal emitted when the windows opacity is changed. w The window whose opacity level is changed. oldOpacity The previous opacity level newOpacity The new opacity level 4.7
* '''windowMinimized(KWin::EffectWindow *w)''': Signal emitted when a window got minimized. w The window which was minimized 4.7
* '''windowUnminimized(KWin::EffectWindow *w)''': Signal emitted when a window got unminimized. w The window which was unminimized 4.7
* '''windowDamaged(KWin::EffectWindow *w, const QRect &r)''': Signal emitted when an area of a window is scheduled for repainting. Use this signal in an effect if another area needs to be synced as well. w The window which is scheduled for repainting r The damaged rect 4.7
* '''tabBoxAdded(int mode)''': Signal emitted when a tabbox is added. An effect who wants to replace the tabbox with itself should use mode The TabBoxMode. refTabBox tabBoxClosed tabBoxUpdated tabBoxKeyEvent 4.7
* '''tabBoxClosed()''': Signal emitted when the TabBox was closed by KWin core. An effect which referenced the TabBox should use to unref again. unrefTabBox tabBoxAdded 4.7
* '''tabBoxUpdated()''': Signal emitted when the selected TabBox window changed or the TabBox List changed. An effect should only response to this signal if it referenced the TabBox with refTabBox currentTabBoxWindowList currentTabBoxDesktopList currentTabBoxWindow currentTabBoxDesktop 4.7
* '''tabBoxKeyEvent(QKeyEvent *event)''': Signal emitted when a key event, which is not handled by TabBox directly is, happens while TabBox is active. An effect might use the key event to e.g. change the selected window. An effect should only response to this signal if it referenced the TabBox with event The key event not handled by TabBox directly refTabBox 4.7
* '''currentTabAboutToChange(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabAdded(KWin::EffectWindow *from, KWin::EffectWindow *to)'''
* '''tabRemoved(KWin::EffectWindow *c, KWin::EffectWindow *group)'''
* '''mouseChanged(const QPoint &pos, const QPoint &oldpos, Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons, Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers)''': Signal emitted when mouse changed. If an effect needs to get updated mouse positions, it needs to first call For a fullscreen effect it is better to use an input window and react on windowInputMouseEvent. pos The new mouse position oldpos The previously mouse position buttons The pressed mouse buttons oldbuttons The previously pressed mouse buttons modifiers Pressed keyboard modifiers oldmodifiers Previously pressed keyboard modifiers. startMousePolling 4.7
* '''propertyNotify(KWin::EffectWindow *w, long atom)''': Receives events registered for using Use readProperty() to get the property data. Note that the property may be already set on the window, so doing the same processing from windowAdded() (e.g. simply calling propertyNotify() from it) is usually needed. w The window whose property changed, is null if it is a root window property atom The property 4.7
* '''showOutline(const QRect &outline)''': Requests to show an outline. An effect providing to show an outline should connect to the signal and render an outline. The outline should be shown till the signal is emitted again with a new geometry or the signal is emitted. outline The geometry of the outline to render. hideOutline 4.7
* '''hideOutline()''': Signal emitted when the outline should no longer be shown. showOutline 4.7
* '''screenGeometryChanged(const QSize &size)''': Signal emitted after the screen geometry changed (e.g. add of a monitor). Effects using displayWidth()/displayHeight() to cache information should react on this signal and update the caches. size The new screen size 4.8
* '''currentActivityChanged(const QString &id)''': This signal is emitted when the global activity is changed id id of the new current activity 4.9
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity 4.9
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity 4.9
=== Functions ===

* '''moveWindow(KWin::EffectWindow *w, const QPoint &pos, bool snap=false, double snapAdjust=1.0)=0'''
* '''windowToDesktop(KWin::EffectWindow *w, int desktop)=0'''
* '''windowToScreen(KWin::EffectWindow *w, int screen)=0'''
* ''int'' '''desktopAbove(int desktop=0, bool wrap=true) const =0''': The ID of the desktop above desktop id. Wraps around to the bottom of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToRight(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the right of desktop id. Wraps around to the left of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopBelow(int desktop=0, bool wrap=true) const =0''': The ID of the desktop below desktop id. Wraps around to the top of the layout if wrap is set. If id is not set use the current one.
* ''int'' '''desktopToLeft(int desktop=0, bool wrap=true) const =0''': The ID of the desktop to the left of desktop id. Wraps around to the right of the layout if wrap is set. If id is not set use the current one.
* ''QString'' '''desktopName(int desktop) const =0'''
* ''int'' '''screenNumber(const QPoint &pos) const =0'''
* ''KWin::EffectWindow *'' '''findWindow(WId id) const =0'''
* '''addRepaintFull()=0''': Schedules the entire workspace to be repainted next time. If you call it during painting (including prepaint) then it does not affect the current painting.
* '''addRepaint(const QRect &r)=0'''
* '''addRepaint(const QRegion &r)=0'''
* '''addRepaint(int x, int y, int w, int h)=0'''

== KWin::EffectWindow ==
Representation of a window used by/for Effect classes.
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''QRect'' '''geometry'''
* ''QRect'' '''expandedGeometry'''
* ''int'' '''height'''
* ''qreal'' '''opacity'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops'''
* ''bool'' '''onCurrentDesktop'''
* ''QRect'' '''rect'''
* ''QString'' '''windowClass'''
* ''QString'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''managed''': Whether this EffectWindow is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this EffectWindow represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
* ''QRegion'' '''shape''': The Window's shape
* ''QString'' '''caption''': The Caption of the window. Read from WM_NAME property together with a suffix for hostname and shortcut.
* ''bool'' '''keepAbove''': Whether the window is set to be kept above other windows.
* ''bool'' '''modal''': Whether the window represents a modal window.
* ''bool'' '''moveable''': Whether the window is moveable. Even if it is not moveable, it might be possible to move it to another screen. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the window can be moved to another screen. moveable
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
* ''bool'' '''move''': Whether the window is currently being moved by the user.
* ''bool'' '''resize''': Whether the window is currently being resized by the user.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them.
* ''QPixmap'' '''icon'''
* ''bool'' '''skipSwitcher''': Whether the window should be excluded from window switching effects.
* ''QRect'' '''contentsRect''': Geometry of the actual window contents inside the whole (including decorations) window.
* ''QRect'' '''decorationInnerRect''': Geometry of the transparent rect in the decoration. May be different from contentsRect if the decoration is extended into the client area.
* ''bool'' '''hasDecoration'''
* ''QStringList'' '''activities'''
* ''bool'' '''onCurrentActivity'''
* ''bool'' '''onAllActivities'''
=== Read-write Properties ===

* ''bool'' '''minimized''': Whether the window is minimized.
=== Signals ===

=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* ''bool'' '''isOnActivity(QString id) const '''
* ''KWin::EffectWindow *'' '''findModal()=0'''
* ''EffectWindowList'' '''mainWindows() const =0'''
* '''closeWindow() const '''
* '''setData(int role, const QVariant &data)=0''': Can be used to by effects to store arbitrary data in the EffectWindow.
* ''QVariant'' '''data(int role) const =0'''

== KWin::AnimationData ==

=== Read-only Properties ===

=== Read-write Properties ===

* ''KWin::AnimationEffect::Anchor'' '''sourceAnchor'''
* ''KWin::AnimationEffect::Anchor'' '''targetAnchor'''
* ''int'' '''relativeSourceX'''
* ''int'' '''relativeSourceY'''
* ''int'' '''relativeTargetX'''
* ''int'' '''relativeTargetY'''
* ''Axis'' '''axis'''
=== Signals ===

=== Functions ===

== KWin::ScriptedEffect ==

'''Inherits:''' KWin::AnimationEffect
=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''configChanged()''': Signal emitted whenever the effect's config changed.
=== Functions ===

* '''animate(KWin::EffectWindow *w, Attribute a, int ms, KWin::FPx2 to, KWin::FPx2 from=KWin::FPx2(), KWin::AnimationData *data=NULL, QEasingCurve curve=QEasingCurve(), int delay=0)'''
* ''bool'' '''isGrabbed(KWin::EffectWindow *w, DataRole grabRole)''': Whether another effect has grabbed the w with the given grabRole. w The window to check grabRole The grab role to check true if another window has grabbed the effect, false otherwise
* ''QVariant'' '''readConfig(const QString &key, const QVariant defaultValue=QVariant())''': Reads the value from the configuration data for the given key. key The key to search for defaultValue The value to return if the key is not found The config value if present

Development/Tutorials/KWin/Effects/JS API

2012-10-26T14:09:41Z

Mgraesslin: Created page with "== Global == Methods and properties added to the global JavaScript object. === Read-only Properties === * ''KWin::ScriptedEffect'' '''effect''': Global property to the actu..."

Schedules/KDE4/4.10 Feature Plan

2012-10-25T20:23:50Z

Mgraesslin:

This is a list of planned features for the SC 4.10 release.

See also:

*[[Schedules/KDE4/4.10 Release Schedule]]
*[[Schedules/KDE4/4.9 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
|}
NO NEW FEATURES ALLOWED
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|QML Containments|Making it possible to do full-featured containments in QML|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|nepomuk-indexer|New Nepomuk Indexer|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukbakcup|Nepomuk Backup rewritten from scratch|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcleaner|An application to port/clean invalid/legacy data in Nepomuk|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk KCM|Rewrite the Nepomuk KCM|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk tags|Nepomuk Tags KIO Slave|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk filemetadtawdiget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows ({{bug |102607}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt ({{bug |266596}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects ({{bug |296773}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Animate Window Maximize/Restore ({{bug |308990}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ExtendedBorderRegion to stable API ({{bug |308994}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support shortened titles like in bespin in all decorations ({{bug |308995}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Mouse Click effect ({{bug |309006}}, Review 105780)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Decorations not visible ({{bug |305875}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|drag-and-drop between windows by cover switch alt-tab causes apps to crash ({{bug |179077}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add a rule to select the screen ({{bug |183996}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Need Mouse navigation in flip switch mode ({{bug |244439}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Allow direct rendering with fglrx ({{bug |301103}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Don't use OpenGL matrix stack in OpenGL 2 backend ({{bug |303093}}, Review 105455)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Refactor Screen/Window PaintData ({{bug |303314}}, Review 105141)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Rapid flickering in locked screen -- makes it difficult to unlock ({{bug |303579}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|double click menu to close needs GUI config ({{bug |305738}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Toplevel::windowType() needs performance improvements ({{bug |306384}}, Review 106349)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GLPlatform should recommend either OpenGL1 or OpenGL2 compositing ({{bug |306436}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Zoom effect broken in master ({{bug |307609}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin fails to build when the GLES support is disabled ({{bug |307866}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Some effect authors are listed as "Name1 & Name2" ({{bug |307928}}, Review 106880)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add screen management actions to window context menus ({{bug |269207}}, Review 106065)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Move Workspace's compositing functionality to own class Compositor ({{bug |299277}}, Review 102420)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Option to disable close on double click in Aurorae ({{bug |301327}}, Review 106160)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Remove Tiling Support From KWin ({{bug |303090}}, Review 105546)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Allow Scripts to add menus to useractions menu ({{bug |303756}}, Review 106285)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Generic QML support for Aurorae Themes ({{bug |303810}}, Review 105768)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Split out Useractions Menu from Workspace ({{bug |305832}}, Review 106085)|mgraesslin@kde.org}}


{{FeatureInProgress|kwin|Implement color correction (Review 106141)|skeletk13@gmail.com|Casian Andrei}}
{{FeatureInProgress|oxygen decoration|Implement ExtendedBorderRegion support, to resize windows outside of their actual borders|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|oxygen style|Implement BlurBehind semi-transparent tooltips when available|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|plasma-wallpapers|Color wallpaper: add listview to display thumbnails for background mode|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureInProgress|plasma workspace|Port Notifications applet to QML|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureInProgress|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureDone|System Tray|System tray with interface in QML|dmitry.ashkadov@gmail.com|Dmitry Ashkadov}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|systemsettings|Keyboard layout preview|amourphious1992@gmail.com|Shivam Makkar}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Split into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|FolderView|Port to QML|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}

{{FeatureTodo|Dolphin|Implement parallel sort algorithm|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}

{{FeatureTodo|Dolphin|Add GUI option for the "Rename Inline" setting|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureTodo|Dolphin|Add "Icon Size" submenu to the Places Panel context menu|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|print-manager|New Print manager KCM and applet (plasmoid) replacement, using C++ |dantti12@gmail.com|Daniel Nicoletti}}

{{FeatureDone|Kate|Support for Python plugins|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Advanced gid(1) plugin using both ID files and etags|srhaque@theiet.org|Shaheed Haque}}

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Macro support|kdedevel@etothepiplusone.com|Simon St James}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Rocs|Journal files for projects.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Revisit graph export/import functionality to fully support: TGF, DOT, GML, GraphML|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Main Window UI Reorganization|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Edit Menu|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Code Editor Configuration Dialog|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|KTouch|Ship ktouch/next|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Smart resizing of training screen with aligned vertical lines|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Prominent hint during training if the user makes repeatedly errors|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Show course descriptions in course selector|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Show a message when keyboard layout visualizion isn't available due missing data|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|Analitza|New plotting framework|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureDone|KAlgebra|Splitted the QML Components from KAlgebraMobile|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|New plotting plasmoid graphs, in QtQuick|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|Pairs|Pairs Theme editor|marco.calignano@gmail.com|Marco Calignano}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Mark right angles|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/KDE_Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|KGoldrunner|Use KGameRenderer and QGraphicsView for all graphics: the gameplay is the same as before.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Remove the status bar. All scores and status messages are in the viewport now.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Allow the displayed speed of moves to be adjusted.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Animate multi-stage moves, to make it easier for a human player to follow their progress.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Show multi-stage moves in an order that is easier to follow.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Validate the loading of saved games and report errors.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Rewrite the main AI class and make it use a true Minimax method.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide a choice of two AI styles, Kepler and Newton, with the possibility to add more.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add settings to choose computer player, AI style and skill level for either or both of players 1 and 2.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add board sizes 3x3 and 4x4, for simplified play.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Add a simple Print facility for KSudoku puzzles.|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}
{{FeatureInProgress|okular|Tiled rendering|okular-devel@kde.org|Okular Developers}}
{{FeatureInProgress|Gwenview|Recursive importer|agateau@kde.org|Aurélien Gâteau}}
{{FeatureInProgress|Gwenview|Color profile support|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add lyrics view|martin.sandsmark@kde.org|Martin Sandsmark}}

|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KGet|Metalink/HTTP Support|dahalaishraj@gmail.com|Aish Raj Dahal}}

|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
{{FeatureInProgress|ComicStrip|Replace with QML version|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureInProgress|Calculator|Replace with QML version|luizromario@gmail.com|Luiz Romário Santana Rios}}
{{FeatureDone|QML Wallpapers|Make it possible to have animated wallpapers written in QtQuick technologies.|aleixpol@blue-systems.com|Aleix Pol Gonzalez}}
{{FeatureDone|Dictionary KRunner|Look up words in the dictionary by typing in 'define {word}' in krunner.|Jason@zx2c4.com|Jason A. Donenfeld}}
{{FeatureInProgress|Calculator|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Umbrello|Line based diagram grid |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello| widget resize and diagram auto resize feature |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello|add spline based association lines to avoid autolayout widget/line overlapping (needs volunteers)|ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
|}

Schedules/KDE4/4.10 Feature Plan

2012-10-25T17:50:23Z

Mgraesslin:

This is a list of planned features for the SC 4.10 release.

See also:

*[[Schedules/KDE4/4.10 Release Schedule]]
*[[Schedules/KDE4/4.9 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
|}
NO NEW FEATURES ALLOWED
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|QML Containments|Making it possible to do full-featured containments in QML|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|nepomuk-indexer|New Nepomuk Indexer|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukbakcup|Nepomuk Backup rewritten from scratch|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcleaner|An application to port/clean invalid/legacy data in Nepomuk|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk KCM|Rewrite the Nepomuk KCM|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk tags|Nepomuk Tags KIO Slave|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk filemetadtawdiget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows ({{bug |102607}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt ({{bug |266596}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects ({{bug |296773}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Animate Window Maximize/Restore ({{bug |308990}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Configurable quick tile area ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Decorations not visible ({{bug |305875}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|drag-and-drop between windows by cover switch alt-tab causes apps to crash ({{bug |179077}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add a rule to select the screen ({{bug |183996}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Need Mouse navigation in flip switch mode ({{bug |244439}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Allow direct rendering with fglrx ({{bug |301103}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Don't use OpenGL matrix stack in OpenGL 2 backend ({{bug |303093}}, Review 105455)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Refactor Screen/Window PaintData ({{bug |303314}}, Review 105141)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Rapid flickering in locked screen -- makes it difficult to unlock ({{bug |303579}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|double click menu to close needs GUI config ({{bug |305738}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Toplevel::windowType() needs performance improvements ({{bug |306384}}, Review 106349)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GLPlatform should recommend either OpenGL1 or OpenGL2 compositing ({{bug |306436}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Zoom effect broken in master ({{bug |307609}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin fails to build when the GLES support is disabled ({{bug |307866}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Some effect authors are listed as "Name1 & Name2" ({{bug |307928}}, Review 106880)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add screen management actions to window context menus ({{bug |269207}}, Review 106065)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Move Workspace's compositing functionality to own class Compositor ({{bug |299277}}, Review 102420)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Option to disable close on double click in Aurorae ({{bug |301327}}, Review 106160)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Remove Tiling Support From KWin ({{bug |303090}}, Review 105546)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Allow Scripts to add menus to useractions menu ({{bug |303756}}, Review 106285)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Generic QML support for Aurorae Themes ({{bug |303810}}, Review 105768)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Split out Useractions Menu from Workspace ({{bug |305832}}, Review 106085)|mgraesslin@kde.org}}


{{FeatureDone|plasma-wallpapers|Color wallpaper: add listview to display thumbnails for background mode|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureInProgress|plasma workspace|Port Notifications applet to QML|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureInProgress|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureDone|System Tray|System tray with interface in QML|dmitry.ashkadov@gmail.com|Dmitry Ashkadov}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|systemsettings|Keyboard layout preview|amourphious1992@gmail.com|Shivam Makkar}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Split into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|FolderView|Port to QML|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}

{{FeatureTodo|Dolphin|Implement parallel sort algorithm|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}

{{FeatureTodo|Dolphin|Add GUI option for the "Rename Inline" setting|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureTodo|Dolphin|Add "Icon Size" submenu to the Places Panel context menu|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|print-manager|New Print manager KCM and applet (plasmoid) replacement, using C++ |dantti12@gmail.com|Daniel Nicoletti}}

{{FeatureDone|Kate|Support for Python plugins|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Advanced gid(1) plugin using both ID files and etags|srhaque@theiet.org|Shaheed Haque}}

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Macro support|kdedevel@etothepiplusone.com|Simon St James}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Rocs|Journal files for projects.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Revisit graph export/import functionality to fully support: TGF, DOT, GML, GraphML|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Main Window UI Reorganization|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Edit Menu|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Code Editor Configuration Dialog|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|KTouch|Ship ktouch/next|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Smart resizing of training screen with aligned vertical lines|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Prominent hint during training if the user makes repeatedly errors|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Show course descriptions in course selector|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureTodo|KTouch|Show a message when keyboard layout visualizion isn't available due missing data|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|Analitza|New plotting framework|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureDone|KAlgebra|Splitted the QML Components from KAlgebraMobile|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|New plotting plasmoid graphs, in QtQuick|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|Pairs|Pairs Theme editor|marco.calignano@gmail.com|Marco Calignano}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Mark right angles|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/KDE_Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|KGoldrunner|Use KGameRenderer and QGraphicsView for all graphics: the gameplay is the same as before.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Remove the status bar. All scores and status messages are in the viewport now.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Allow the displayed speed of moves to be adjusted.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Animate multi-stage moves, to make it easier for a human player to follow their progress.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Show multi-stage moves in an order that is easier to follow.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Validate the loading of saved games and report errors.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Rewrite the main AI class and make it use a true Minimax method.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide a choice of two AI styles, Kepler and Newton, with the possibility to add more.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add settings to choose computer player, AI style and skill level for either or both of players 1 and 2.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add board sizes 3x3 and 4x4, for simplified play.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Add a simple Print facility for KSudoku puzzles.|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}
{{FeatureInProgress|okular|Tiled rendering|okular-devel@kde.org|Okular Developers}}
{{FeatureInProgress|Gwenview|Recursive importer|agateau@kde.org|Aurélien Gâteau}}
{{FeatureInProgress|Gwenview|Color profile support|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add lyrics view|martin.sandsmark@kde.org|Martin Sandsmark}}

|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KGet|Metalink/HTTP Support|dahalaishraj@gmail.com|Aish Raj Dahal}}

|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
{{FeatureInProgress|ComicStrip|Replace with QML version|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureInProgress|Calculator|Replace with QML version|luizromario@gmail.com|Luiz Romário Santana Rios}}
{{FeatureDone|QML Wallpapers|Make it possible to have animated wallpapers written in QtQuick technologies.|aleixpol@blue-systems.com|Aleix Pol Gonzalez}}
{{FeatureDone|Dictionary KRunner|Look up words in the dictionary by typing in 'define {word}' in krunner.|Jason@zx2c4.com|Jason A. Donenfeld}}
{{FeatureInProgress|Calculator|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
|}

Projects/KWin/Build Options

2012-10-25T09:43:55Z

Mgraesslin: KWIN_BUILD_OPENGL_1_COMPOSITING build option

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_OXYGEN ==
'''Default:''' ''ON''

Builds the Oxygen window decoration. This build option is only meant to make it easier to build only KWin without anything else from kde-workspace.

'''Since 4.10'''

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts.

'''Removed in 4.10, tiling no longer available'''

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_OPENGL_1_COMPOSITING ==
'''Default:''' ''ON'' (''OFF'' for GLES only builds)

Builds OpenGL 1 based compositing support

'''Since 4.10'''

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Projects/KWin/Build Options

2012-10-05T07:54:19Z

Mgraesslin:

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_OXYGEN ==
'''Default:''' ''ON''

Builds the Oxygen window decoration. This build option is only meant to make it easier to build only KWin without anything else from kde-workspace.

'''Since 4.10'''

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts.

'''Removed in 4.10, tiling no longer available'''

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Projects/KWin/Build Options

2012-10-05T07:54:02Z

Mgraesslin:

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

'''Since 4.10'''

== KWIN_BUILD_OXYGEN ==
'''Default:''' ''ON''

Builds the Oxygen window decoration. This build option is only meant to make it easier to build only KWin without anything else from kde-workspace.

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts.

'''Removed in 4.10, tiling no longer available'''

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Projects/KWin/Build Options

2012-10-05T07:53:17Z

Mgraesslin:

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_OXYGEN ==
'''Default:''' ''ON''

Builds the Oxygen window decoration. This build option is only meant to make it easier to build only KWin without anything else from kde-workspace.

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts.

'''Removed in 4.10, tiling no longer available'''

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Schedules/KDE4/4.9 Release Schedule

2012-07-22T09:36:13Z

Mgraesslin: Restore release schedule for 4.9: Undo revision 73884 by Winterz (talk)

KDE SC 4.9 is a feature release for KDE SC 4. All dates given here are subject to revision, but we will try our best to stick to them if possible. The KDE Release Team is acting as the coordinator for this release.

All deadlines are due 23:59 UTC, but if you need a few more hours, notify someone from the release team.

(the below schedule is generated based on software. Don't edit below, but edit the software and regenerate the schedule.)

You can also add [http://www.kde.org/releaseschedule.ics http://www.kde.org/releaseschedule.ics] as remote calendar to korganizer so you always have the release schedule near you.

== KDE SC 4.9 ==

=== Thursday, May 3, 2012: KDE 4.9 Soft Feature Freeze ===
Trunk is frozen for feature commits that are not listed in the planned feature document. Only bugfixes and the code implementing the listed features are to be committed after this date. The feature list also closes today.

Features not already finished or not listed on the planned features page will have to wait until the next KDE SC release.

=== Thursday, May 10, 2012: KDE 4.9 Dependency Freeze ===
From this moment on it is not allowed to add new dependencies or bump dependencies versions. It is possible to get an exception for this. Post the patch to reviewboard and add the release-team as reviewer. We will check if the dependency is needed and is available on all platforms.

In other words: If you have a feature that requires a new dependency or a version of a dependency that is higher than currently checked for in the build system, you need to have committed this change before this date.

=== Thursday, May 17, 2012: KDE 4.9 Soft Message Freeze ===
All translated messages (GUI strings) are frozen on this date. Only previously untranslated strings or clear errors in strings can be fixed. No major new strings changes should be done. You cannot add new strings, if you really need one ask kde-i18n-doc for an exception. It is ok to remove strings. Exception: Artwork (try to keep the number of new strings low anyways). Exception: Typo fixes can be fixed until the Hard Message Freeze, but you have to mail kde-i18n-doc saying you made a typo fix change.

=== Thursday, May 17, 2012: KDE 4.9 Soft API Freeze ===
To allow the bindings people to have proper time to do their work in preparation to the final release, the API should now be mostly fixed. Changing API is allowed, but commits have to be cc'ed to the kde-bindings mailinglist. This is including older APIs and newly introduced libraries/APIs.

=== Thursday, May 17, 2012: KDE 4.9 Hard Feature Freeze ===
Trunk is frozen for all feature commits, even those listed in the planned feature document. Only bug fixes are allowed.

=== Thursday, May 24, 2012: KDE 4.9 Beta 1 Tagging ===
Trunk is frozen for beta release tagging. Only urgent fixes, such as those fixing compilation errors, should be committed. The usual beta rules apply as soon as the Beta tarballs have been generated.

=== Wednesday, May 30, 2012: KDE 4.9 Beta 1 Release ===
The beta becomes available for general consumption.

=== Thursday, June 7, 2012: KDE 4.9 Beta 2 Tagging ===
Trunk is frozen for beta release tagging. Only urgent fixes, such as those fixing compilation errors, should be committed. The usual beta rules apply as soon as the Beta tarballs have been generated.

=== Wednesday, June 13, 2012: KDE 4.9 Beta 2 Release ===
The beta becomes available for general consumption.

=== Monday, June 25, 2012: KDE 4.9 Tagging Freeze for Release Candidate 1 ===
During tagging freeze only compilation fixes for all platforms are allowed to be committed. Everything else (even showstopper fixes) *have* to be run through reviewboard, with the release-team and the affected maintainers as reviewer.

=== Monday, June 25, 2012: KDE 4.9 Hard API Freeze ===
To allow the bindings people to have proper time to do there work in preparation to the final release, the API is now frozen. No more changes to APIs or header files (except docs) after this date, including older APIs and newly introduced libraries/APIs.

=== Monday, June 25, 2012: KDE 4.9 Hard Message Freeze ===
Up to now you were able to do typo changes, but you had to mail kde-i18n-doc saying you made a typo fix change. From this moment on you need to contact kde-i18n-doc for every single string change, if noone objects in 5 days you can commit the change.

=== Monday, June 25, 2012: KDE 4.9 Artwork and Bindings Freeze ===
All artwork is frozen on this date. No new artwork should be added. Existing artwork can continue to be tweaked and fixed.

No new additions to the language bindings, except optional bindings as permitting by the kde-bindings team.

=== Monday, June 25, 2012: KDE 4.9 Documentation Freeze ===
No more changes to documentation or handbooks after this date. For typos, spelling and simple grammar changes you have to mail kde-i18n-doc for approval.

=== Tuesday, June 26, 2012: KDE 4.9 Release Candidate 1 Tagging ===
Branch is frozen for release candidate tagging. Only urgent fixes, such as those fixing compilation errors, should be committed.

=== Wednesday, June 27, 2012: KDE 4.9 Release Candidate 1 Release ===
The release candidate is tagged from the branch. Only urgent fixes, such as those fixing compilation errors, should be committed.As soon as the RC has been confirmed to build it will be released immediately.

=== Monday, July 9, 2012: KDE 4.9 Tagging Freeze for Release Candidate 2 ===
During tagging freeze only compilation fixes for all platforms are allowed to be committed. Everything else (even showstopper fixes) *have* to be run through reviewboard, with the release-team and the affected maintainers as reviewer.

=== Tuesday, July 10, 2012: KDE 4.9 Release Candidate 2 Tagging ===
Branch is frozen for release candidate tagging. Only urgent fixes, such as those fixing compilation errors, should be committed.

=== Wednesday, July 11, 2012: KDE 4.9 Release Candidate 2 Release ===
The release candidate is tagged from the branch. Only urgent fixes, such as those fixing compilation errors, should be committed.As soon as the RC has been confirmed to build it will be released immediately.

=== Wednesday, July 25, 2012: KDE 4.9 Final Tag ===
The branch is frozen for final release tagging. Only urgent fixes, such as those fixing compilation errors, should be committed.

=== Wednesday, August 1, 2012: KDE 4.9 Release ===
Final release is released for general consumption.

=== Thursday, September 27, 2012: KDE 4.9.1 tagging ===
A KDE minor release is tagged and made available to the packagers.

=== Tuesday, October 2, 2012: KDE 4.9.1 release ===
A KDE minor release is released to the public.

=== Thursday, November 1, 2012: KDE 4.9.2 tagging ===
A KDE minor release is tagged and made available to the packagers.

=== Tuesday, November 6, 2012: KDE 4.9.2 release ===
A KDE minor release is released to the public.

=== Thursday, November 29, 2012: KDE 4.9.3 tagging ===
A KDE minor release is tagged and made available to the packagers.

=== Tuesday, December 4, 2012: KDE 4.9.3 release ===
A KDE minor release is released to the public.

=== Thursday, January 10, 2013: KDE 4.9.4 tagging ===
A KDE minor release is tagged and made available to the packagers.

=== Tuesday, January 15, 2013: KDE 4.9.4 release ===
A KDE minor release is released to the public.

Projects/KWin/Build Options

2012-07-14T10:26:08Z

Mgraesslin: /* KWIN_BUILD_TILING */

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts.

'''Removed in 4.10, tiling no longer available'''

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Development/Tutorials/KWin/Scripting/API 4.9

2012-06-24T17:25:38Z

Mgraesslin: /* KWin::WorkspaceWrapper */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
* ''QString'' '''currentActivity'''
* ''QStringList'' '''activities'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
* '''currentActivityChanged()''': Signal emitted whenever the current activity changed.
* '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity

=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape

=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!

=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-06-24T17:25:11Z

Mgraesslin: /* Signals */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
* '''currentActivityChanged()''': Signal emitted whenever the current activity changed.
* '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity
* '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity
* '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity

=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape

=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!

=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-06-24T17:24:23Z

Mgraesslin: /* Read-write Properties */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape

=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -1.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!

=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-06-24T17:23:40Z

Mgraesslin: /* Read-only Properties */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1.
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape

=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-06-24T17:23:05Z

Mgraesslin: /* Functions */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.
* ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-05-31T06:56:01Z

Mgraesslin: /* Functions */

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.
* ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.
* ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Schedules/KDE4/4.9 Feature Plan

2012-05-18T08:44:17Z

Mgraesslin: Updated KWin features

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureDone|Kate Part|Reworked Color Configuration|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|KActivities|Encryption for private activities (not available via UI).|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|KActivities|Linking files to activities in Dolphin, Konqueror, Folder View.|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|KActivities|Activities KIO.|ivan.cukic@kde.org|Ivan Čukić}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}
{{FeatureDone|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes ({{bug |296065}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|GHNS support for KWin Scripts ({{bug |296774}}, Review 104877)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 ({{bug |296775}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|GHNS support for Window Switching Layouts ({{bug |297636}}, Review 104894)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts ({{bug |297638}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|ThumbnailItem allows upscaling of Windows ({{bug |297864}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Increase ABI version for KDecorations ({{bug |299140}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Useraction menu closes when focus passes to another window ({{bug |81743}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: change focus only when moving mouse ({{bug |92290}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications ({{bug |124612}}, Review 104457)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Insufficient stacking order handling for deleted windows ({{bug |158262}}, Review 104519)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. ({{bug |178595}}, Review 104438)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|No reason given why some desktop effects cannot be activated ({{bug |209213}}, Review 104847)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Dragging a title bar against a bottom panel twice makes it go under the panel on the second time ({{bug |210926}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Wobbly windows wobbles strange after quick-maximization ({{bug |222102}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Move" command should allow off-screen window moving same as Alt + click trick ({{bug |229942}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Bug with shading always inactive windows ({{bug |242217}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." ({{bug |249486}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars ({{bug |260938}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Placement Policy 'under mouse' ({{bug |272162}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects ({{bug |273478}}, Review 104436)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|closing session crash ({{bug |282933}}, Review 104690)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function ({{bug |286783}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions ({{bug |288960}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab ({{bug |291916}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashed when I was switching windows ({{bug |292614}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Kill helper should be out of process ({{bug |295940}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager ({{bug |296056}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Different binary name for KWin Active ({{bug |296084}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Switcher KCM needs to be reworked ({{bug |297639}}, Review 104525)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Document global JavaScript methods in KWin Scripting API documentation ({{bug |297640}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Elevate windows in addition to highlight ({{bug |297809}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes when interacting with Plasma ({{bug |298669}}, Review 104714)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add ABI check to KDecorations ({{bug |299141}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Effects cannot be configured ({{bug |299163}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Adding proper window thumbnail clipping to the QML tabbox ({{bug |299198}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Improve VSync strategy ({{bug |299274}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Screen Edge bindings for KWin Scripting ({{bug |299275}}, Review 104904)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Better QML selection list for Window Switcher layout ({{bug |299278}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add layout specification to D-Bus call for invoking TabBox ({{bug |299279}}, Review 104838)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Default Bindings for Switching between Windows of current Application ({{bug |299308}}, Review 104730)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Make desktop focus chains activities aware ({{bug |299309}}, Review 104649)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Desktop Zoom should be saved between sessions ({{bug |189956}}, Review 104597)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureDone|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureDone|Konsole|Add command line options for controlling the visibility of menubar and tabbar|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
{{FeatureDone|Pairs|New memory game|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra Mobile|Many improvements, including Android and better Active support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}
{{FeatureInProgress|Okular|Store annotations with documents {{bug |151614}}|okular-devel@kde.org|}}
{{FeatureInProgress|Okular|Print document with annotations {{bug |159005}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Annotations Screen support (embedded movies in PDF) {{bug |172847}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Aggressive page preloading {{bug |184196}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Hyphen-aware search {{bug |190433}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Multiple bookmarks per page {{bug |157198}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Allow the renaming of bookmark "parent" items|okular-devel@kde.org|}}
{{FeatureDone|Okular|Allow the page number selector to be added to the toolbar {{bug |279128}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Double click to select workds {{bug |187347}}|okular-devel@kde.org|}}
{{FeatureDone|Okular|Make Okular inhibit sleep and screen power management when in Presentation mode|okular-devel@kde.org|}}
{{FeatureInProgress|Okular|Behavior for left/right arrow keys|okular-devel@kde.org|}}
{{FeatureDone|Okular|Remember the mouse mode on exit|okular-devel@kde.org|}}
{{FeatureDone|Okular|Make search from the current page the default|okular-devel@kde.org|}}
|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
{{FeatureDone|Dragon|MPRIS2 support|hein@kde.org|Eike Hein}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureDone|Import pim data|ImportWizard allows to import settings/mails/filters/calendar/addressbook from thunderbird/evolution/etc. when exists.|montel@kde.org|Laurent Montel}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureDone|Thumbnail|PO thumbnailer|shuizhuyuanluo@126.com|Ni Hui}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.9 Feature Plan

2012-05-08T18:48:16Z

Mgraesslin: InProgress for KWin

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows (Bug 213847)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 (Bug 296076)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|No reason given why some desktop effects cannot be activated (Bug 209213, Review 104847)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Drop BoxSwitch effect (Bug 296071, Review 104454)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|GHNS support for KWin Scripts (Bug 296774, Review 104877)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 (Bug 296775)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org (Bug 297634)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org (Bug 297635)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Window Switcher KCM needs to be reworked (Bug 297639, Review 104525)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|ThumbnailItem allows upscaling of Windows (Bug 297864)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Redesign the kwin's kcm "All effects" (Bug 298991, Review 104849)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae (Bug 299138)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Increase ABI version for KDecorations (Bug 299140)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add ABI check to KDecorations (Bug 299141)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|New Window Decoration for Thin Clients (Bug 299143)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations (Bug 299144, Review 104281)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting (Bug 299245)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts (Bug 299247)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Improve VSync strategy (Bug 299274)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Screen Edge bindings for KWin Scripting (Bug 299275)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support Plasma API Extensions in KWin Scripting (Bug 299276)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Move Workspace's compositing functionality to own class Compositor (Bug 299277, Review 102420)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Better QML selection list for Window Switcher layout (Bug 299278)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Default Bindings for Switching between Windows of current Application (Bug 299308, Review 104730)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Useraction menu closes when focus passes to another window (Bug 81743)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: change focus only when moving mouse (Bug 92290)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612, Review 104457)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Insufficient stacking order handling for deleted windows (Bug 158262, Review 104519)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595, Review 104438)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Dragging a title bar against a bottom panel twice makes it go under the panel on the second time (Bug 210926)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Wobbly windows wobbles strange after quick-maximization (Bug 222102)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Bug with shading always inactive windows (Bug 242217)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478, Review 104436)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|closing session crash (Bug 282933, Review 104690)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashed when I was switching windows (Bug 292614)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Elevate windows in addition to highlight (Bug 297809)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes when interacting with Plasma (Bug 298669, Review 104714)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Effects cannot be configured (Bug 299163)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Adding proper window thumbnail clipping to the QML tabbox (Bug 299198)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add layout specification to D-Bus call for invoking TabBox (Bug 299279, Review 104838)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Make desktop focus chains activities aware (Bug 299309, Review 104649)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Desktop Zoom should be saved between sessions (Bug 189956, Review 104597)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureDone|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureTodo|Konsole|Add command line options for controlling the visibility of menubar and tabbar|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes)|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games, possibly using Get Hot New Stuff|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureDone|Thumbnail|PO thumbnailer|shuizhuyuanluo@126.com|Ni Hui}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.9 Feature Plan

2012-05-03T18:04:53Z

Mgraesslin: update kwin feature plan from target milestone 4.9 list

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows (Bug 213847)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 (Bug 296076)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|No reason given why some desktop effects cannot be activated (Bug 209213)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Drop BoxSwitch effect (Bug 296071)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for KWin Scripts (Bug 296774)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 (Bug 296775)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org (Bug 297634)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org (Bug 297635)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Switcher KCM needs to be reworked (Bug 297639)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|ThumbnailItem allows upscaling of Windows (Bug 297864)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Redesign the kwin's kcm "All effects" (Bug 298991)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae (Bug 299138)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Increase ABI version for KDecorations (Bug 299140)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add ABI check to KDecorations (Bug 299141)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|New Window Decoration for Thin Clients (Bug 299143)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Remove legacy window decorations (Bug 299144)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting (Bug 299245)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts (Bug 299247)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Improve VSync strategy (Bug 299274)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Screen Edge bindings for KWin Scripting (Bug 299275)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support Plasma API Extensions in KWin Scripting (Bug 299276)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move Workspace's compositing functionality to own class Compositor (Bug 299277)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Better QML selection list for Window Switcher layout (Bug 299278)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add layout specification to D-Bus call for invoking TabBox (Bug 299279)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Default Bindings for Switching between Windows of current Application (Bug 299308)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make desktop focus chains activities aware (Bug 299309)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Useraction menu closes when focus passes to another window (Bug 81743)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: change focus only when moving mouse (Bug 92290)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Insufficient stacking order handling for deleted windows (Bug 158262)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Dragging a title bar against a bottom panel twice makes it go under the panel on the second time (Bug 210926)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Wobbly windows wobbles strange after quick-maximization (Bug 222102)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Bug with shading always inactive windows (Bug 242217)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|closing session crash (Bug 282933)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashed when I was switching windows (Bug 292614)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Elevate windows in addition to highlight (Bug 297809)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes when interacting with Plasma (Bug 298669)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Effects cannot be configured (Bug 299163)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Adding proper window thumbnail clipping to the QML tabbox (Bug 299198)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Desktop Zoom should be saved between sessions (Bug 189956)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureDone|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureTodo|Konsole|Add command line options for controlling the visibility of menubar and tabbar|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes)|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureTodo|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games, possibly using Get Hot New Stuff|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Development/Tutorials/KWin/Scripting/API 4.9

2012-04-21T14:06:58Z

Mgraesslin:

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== KWin::WorkspaceWrapper ==

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
* '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again.
* '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience.
* '''hideOutline()''': Hides the outline previously shown by showOutline.
* ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Options ==

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''bool'' '''focusPolicyIsReasonable'''
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
=== Read-write Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''bool'' '''compositingInitialized'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Signals ===

* '''configChanged()'''
* '''focusPolicyChanged()'''
* '''nextFocusPrefersMouseChanged()'''
* '''clickRaiseChanged()'''
* '''autoRaiseChanged()'''
* '''autoRaiseIntervalChanged()'''
* '''delayFocusIntervalChanged()'''
* '''shadeHoverChanged()'''
* '''shadeHoverIntervalChanged()'''
* '''tilingChanged()'''
* '''tilingLayoutChanged()'''
* '''tilingRaisePolicyChanged()'''
* '''separateScreenFocusChanged()'''
* '''activeMouseScreenChanged()'''
* '''placementChanged()'''
* '''borderSnapZoneChanged()'''
* '''windowSnapZoneChanged()'''
* '''centerSnapZoneChanged()'''
* '''snapOnlyWhenOverlappingChanged()'''
* '''showDesktopIsMinimizeAllChanged()'''
* '''rollOverDesktopsChanged()'''
* '''focusStealingPreventionLevelChanged()'''
* '''legacyFullscreenSupportChanged()'''
* '''operationTitlebarDblClickChanged()'''
* '''commandActiveTitlebar1Changed()'''
* '''commandActiveTitlebar2Changed()'''
* '''commandActiveTitlebar3Changed()'''
* '''commandInactiveTitlebar1Changed()'''
* '''commandInactiveTitlebar2Changed()'''
* '''commandInactiveTitlebar3Changed()'''
* '''commandWindow1Changed()'''
* '''commandWindow2Changed()'''
* '''commandWindow3Changed()'''
* '''commandWindowWheelChanged()'''
* '''commandAll1Changed()'''
* '''commandAll2Changed()'''
* '''commandAll3Changed()'''
* '''keyCmdAllModKeyChanged()'''
* '''showGeometryTipChanged()'''
* '''electricBordersChanged()'''
* '''electricBorderDelayChanged()'''
* '''electricBorderCooldownChanged()'''
* '''electricBorderPushbackPixelsChanged()'''
* '''electricBorderMaximizeChanged()'''
* '''electricBorderTilingChanged()'''
* '''borderlessMaximizedWindowsChanged()'''
* '''killPingTimeoutChanged()'''
* '''hideUtilityWindowsForInactiveChanged()'''
* '''inactiveTabsSkipTaskbarChanged()'''
* '''autogroupSimilarWindowsChanged()'''
* '''autogroupInForegroundChanged()'''
* '''compositingModeChanged()'''
* '''useCompositingChanged()'''
* '''compositingInitializedChanged()'''
* '''hiddenPreviewsChanged()'''
* '''unredirectFullscreenChanged()'''
* '''glSmoothScaleChanged()'''
* '''glVSyncChanged()'''
* '''xrenderSmoothScaleChanged()'''
* '''maxFpsIntervalChanged()'''
* '''refreshRateChanged()'''
* '''glDirectChanged()'''
* '''glStrictBindingChanged()'''
=== Functions ===

== KWin::Toplevel ==

'''Inherits:''' KDecorationDefines
=== Read-only Properties ===

* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* '''addRepaint(const QRect &r)'''
* '''addRepaint(const QRegion &r)'''
* '''addRepaint(int x, int y, int w, int h)'''
* '''addLayerRepaint(const QRect &r)'''
* '''addLayerRepaint(const QRegion &r)'''
* '''addLayerRepaint(int x, int y, int w, int h)'''
* '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''bool'' '''tabBefore(Client *other, bool activate)'''
* ''bool'' '''tabBehind(Client *other, bool activate)'''
* ''bool'' '''untab(const QRect &toGeometry=QRect())'''

Development/Tutorials/KWin/Scripting/API 4.9

2012-04-09T20:54:20Z

Mgraesslin: Global

== Global ==
Methods and properties added to the global JavaScript object.
=== Read-only Properties ===

* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core.
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin.
=== Read-write Properties ===

=== Signals ===

=== Functions ===

* ''void'' '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned.
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module.

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< QObject * >'' '''getClientList() const ''': List of Clients currently managed by KWin. Use this method in QML scripts.
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin. Use this method in JavaScript scripts.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Options ==
The Options provide access to KWin internal configuration values. They are available as global '''options''' object.

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''bool'' '''focusPolicyIsReasonable'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Read-write Properties ===

* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''bool'' '''compositingInitialized'''
=== Signals ===

* '''configChanged()'''

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::TabGroup ==

=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''minSizeChanged()'''
* '''maxSizeChanged()'''
=== Functions ===

Development/Tutorials/KWin/Scripting/API 4.9

2012-04-09T19:34:23Z

Mgraesslin: /* KWin::Client */

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< QObject * >'' '''getClientList() const ''': List of Clients currently managed by KWin. Use this method in QML scripts.
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin. Use this method in JavaScript scripts.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Options ==
The Options provide access to KWin internal configuration values. They are available as global '''options''' object.

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''bool'' '''focusPolicyIsReasonable'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Read-write Properties ===

* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''bool'' '''compositingInitialized'''
=== Signals ===

* '''configChanged()'''

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
* ''bool'' '''demandsAttention''': Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Client and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).
* ''bool'' '''blocksCompositing''': A client can block compositing. That is while the Client is alive and the state is set, Compositing is suspended and is resumed when there are no Clients blocking compositing any more.This is actually set by a window property, unfortunately not used by the target application group. For convenience it's exported as a property to the scripts.Use with care!
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes.
* '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::TabGroup ==

=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''minSizeChanged()'''
* '''maxSizeChanged()'''
=== Functions ===

Development/Tutorials/KWin/Scripting/API 4.9

2012-04-09T19:33:07Z

Mgraesslin: Options added

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< QObject * >'' '''getClientList() const ''': List of Clients currently managed by KWin. Use this method in QML scripts.
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin. Use this method in JavaScript scripts.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Options ==
The Options provide access to KWin internal configuration values. They are available as global '''options''' object.

'''Inherits:''' KDecorationOptions
=== Read-only Properties ===

* ''FocusPolicy'' '''focusPolicy'''
* ''bool'' '''nextFocusPrefersMouse'''
* ''bool'' '''clickRaise''': Whether clicking on a window raises it in FocusFollowsMouse mode or not.
* ''bool'' '''autoRaise''': whether autoraise is enabled FocusFollowsMouse mode or not.
* ''int'' '''autoRaiseInterval''': autoraise interval
* ''int'' '''delayFocusInterval''': delayed focus interval
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not
* ''int'' '''shadeHoverInterval''': shade hover interval
* ''int'' '''tilingLayout'''
* ''int'' '''tilingRaisePolicy''': Tiling window raise policy.
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client)
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window)
* ''int'' '''placement'''
* ''bool'' '''focusPolicyIsReasonable'''
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows
* ''int'' '''centerSnapZone''': the size of the zone that triggers snapping on the screen center
* ''bool'' '''snapOnlyWhenOverlapping''': snap only when windows will overlap
* ''bool'' '''showDesktopIsMinimizeAll'''
* ''bool'' '''rollOverDesktops''': whether or not we roll over to the other edge when switching desktops past the edge
* ''int'' '''focusStealingPreventionLevel''': 0 - 4 , see Workspace::allowClientActivation()
* ''bool'' '''legacyFullscreenSupport''': support legacy fullscreen windows hack: borderless non-netwm windows with screen geometry
* ''WindowOperation'' '''operationTitlebarDblClick'''
* ''MouseCommand'' '''commandActiveTitlebar1'''
* ''MouseCommand'' '''commandActiveTitlebar2'''
* ''MouseCommand'' '''commandActiveTitlebar3'''
* ''MouseCommand'' '''commandInactiveTitlebar1'''
* ''MouseCommand'' '''commandInactiveTitlebar2'''
* ''MouseCommand'' '''commandInactiveTitlebar3'''
* ''MouseCommand'' '''commandWindow1'''
* ''MouseCommand'' '''commandWindow2'''
* ''MouseCommand'' '''commandWindow3'''
* ''MouseCommand'' '''commandWindowWheel'''
* ''MouseCommand'' '''commandAll1'''
* ''MouseCommand'' '''commandAll2'''
* ''MouseCommand'' '''commandAll3'''
* ''uint'' '''keyCmdAllModKey'''
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize.
* ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds.
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds.
* ''int'' '''electricBorderPushbackPixels''': the number of pixels the mouse cursor is pushed back when it reaches the screen edge.
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved.
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved
* ''bool'' '''borderlessMaximizedWindows'''
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close
* ''bool'' '''hideUtilityWindowsForInactive''': Whether to hide utility windows for inactive applications.
* ''bool'' '''inactiveTabsSkipTaskbar'''
* ''bool'' '''autogroupSimilarWindows'''
* ''bool'' '''autogroupInForeground'''
* ''int'' '''compositingMode'''
* ''bool'' '''useCompositing'''
* ''int'' '''hiddenPreviews'''
* ''bool'' '''unredirectFullscreen'''
* ''int'' '''glSmoothScale''': 0 = no, 1 = yes when transformed, 2 = try trilinear when transformed; else 1, -1 = auto
* ''bool'' '''glVSync'''
* ''bool'' '''xrenderSmoothScale'''
* ''uint'' '''maxFpsInterval'''
* ''uint'' '''refreshRate'''
* ''bool'' '''glDirect'''
* ''bool'' '''glStrictBinding'''
=== Read-write Properties ===

* ''bool'' '''tiling''': Whether tiling is enabled or not
* ''bool'' '''compositingInitialized'''
=== Signals ===

* '''configChanged()'''

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::TabGroup ==

=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''minSizeChanged()'''
* '''maxSizeChanged()'''
=== Functions ===

Development/Tutorials/KWin/Scripting/API 4.9

2012-04-09T19:31:16Z

Mgraesslin: update Workspace

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *client, int desktop)'''
* '''currentDesktopChanged(int desktop)'''
* '''clientAdded(KWin::Client *client)'''
* '''clientRemoved(KWin::Client *client)'''
* '''clientManaging(KWin::Client *client)'''
* '''clientMinimized(KWin::Client *client)'''
* '''clientUnminimized(KWin::Client *client)'''
* '''clientRestored(KWin::Client *client)'''
* '''clientMaximizeSet(KWin::Client *client, bool h, bool v)'''
* '''killWindowCalled(KWin::Client *client)'''
* '''clientActivated(KWin::Client *client)'''
* '''clientFullScreenSet(KWin::Client *client, bool fullScreen, bool user)'''
* '''clientSetKeepAbove(KWin::Client *client, bool keepAbove)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< QObject * >'' '''getClientList() const ''': List of Clients currently managed by KWin. Use this method in QML scripts.
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin. Use this method in JavaScript scripts.
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::TabGroup ==

=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''minSizeChanged()'''
* '''maxSizeChanged()'''
=== Functions ===

Schedules/KDE4/4.9 Feature Plan

2012-04-09T13:10:14Z

Mgraesslin: KWin Feature Plan (auto-generated from target milestone in bugs.kde.org)

Projects/KWin/Build Options

2012-03-30T08:20:36Z

Mgraesslin: /* KWin Build Options */

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_BUILD_ACTIVITIES ==
'''Default:''' ''ON''

Builds support for KDE's Activity concept.

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Projects/KWin/Build Options

2012-03-27T19:35:16Z

Mgraesslin: Created page with "= KWin Build Options = This document lists and explains the build options available in KWin source code. == KWIN_BUILD_DECORATIONS == '''Default:''' ''ON'' Builds the decorati..."

= KWin Build Options =

This document lists and explains the build options available in KWin source code.

== KWIN_BUILD_DECORATIONS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory clients.

== KWIN_BUILD_KCMS ==
'''Default:''' ''ON''

Builds the decorations in sub-directory kcmkwin

== KWIN_MOBILE_EFFECTS ==
'''Default:''' ''OFF''

Restricts the building of effects to those useful on mobile (touch) environments.

== KWIN_BUILD_TABBOX ==
'''Default:''' ''ON''

Builds tabbox (Alt+Tab) support in sub-directory tabbox

== KWIN_BUILD_TILING ==
'''Default:''' ''ON''

Builds window-tiling support in sub-directory tiling and tilinglayouts

== KWIN_BUILD_SCREENEDGES ==
'''Default:''' ''ON''

Builds support for screen edge activation

== KWIN_BUILD_SCRIPTING ==
'''Default:''' ''ON''

Builds support for KWin's scripting framework in sub-directory scripting

== KWIN_BUILD_XRENDER_COMPOSITING ==
'''Default:''' ''ON''

Builds XRender based compositing support

== KWIN_PLASMA_ACTIVE ==
'''Default:''' ''Enabled for KDE_PLATFORM_PROFILE not Desktop''

Enables build options listed above for Plasma Active.

Projects/KWin

2012-03-27T19:34:41Z

Mgraesslin: /* General information */

{{Template:I18n/Language Navigation Bar|Projects/KWin}}

'''This is a starting page for all relevant KWin documentation, most of which is stored in SVN or on external WWW pages.'''

== General information ==

* [https://mail.kde.org/mailman/listinfo/kwin KWin mailing list]
* IRC channel #kwin on freenode
* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/COMPLIANCE COMPLIANCE] - a document on KWin's compliance to the window manager specifications [http://tronche.com/gui/x/icccm/ ICCCM] and [http://www.freedesktop.org/wiki/Specifications/wm-spec EWMH] (also known as NETWM).
* [[/4.0-release-notes|KDE4.0 release notes]] - information about changes and new features in KWin in KDE4.0
* [[/Build_Options|KWin Build Options]] - documentation on the available build options for KWin.

== Developer information ==

* For Developer Information see the [http://community.kde.org/KWin/ KWin Section] in the KDE Community Wiki
* [http://api.kde.org/4.x-api/kdebase-workspace-apidocs/kwin/lib/html/group__kdecoration.html libkdecoration API documentation] - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version, for other versions: [http://api.kde.org/4.0-api/kdebase-workspace-apidocs/kwin/lib/html/group__kdecoration.html 4.0] ).
* [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Based on KDE3.2 and as such slightly outdated, but it is still usable for newer versions. Note that current decorations should use KCommonDecoration class instead of KDecoration directly like this tutorial does.
* [http://api.kde.org/4.x-api/kdebase-workspace-apidocs/kwin/lib/html/group__kwineffects.html libkwineffects API documentation ] - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [https://projects.kde.org/projects/kde/kdebase/kde-workspace/repository/revisions/master/show/kwin/effects existing effects shipped with KWin] (especially the Howto effect in the tests/ directory as a starting point) and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.
* [[Development/Tutorials/KWin/Scripting/API|Scripting API]] and [[Development/Tutorials/KWin/Scripting|KWin Scripting Tutorial]]
* [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes for version 4.9]]

== Configuration ==

* [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/entry/kwin/CONFIGURING CONFIGURING ] - document on advanced KWin configuration (such as pre-configuring window-specific settings).

Projects/KWin/Scripting Update Notes

2012-03-06T07:12:02Z

Mgraesslin: /* ClientGroup */

The KWin Scripting functionality has been reworked and extended in the KDE Plasma Workspaces version 4.9. Unfortunately it was not possible to keep the API 100 % compatible. This document lists most changes. The new API is documented in [[Development/Tutorials/KWin/Scripting/API_4.9]].

In general the API has been changed to make greater use of Properties. This has been done to be able to use the same API in both JavaScript and QML. So instead of
<syntaxhighlight lang="javascript">
var opacity = client.opacity();
opacity = opacity*0.5;
client.setOpacity(opacity);
</syntaxhighlight>
use
<syntaxhighlight lang="javascript">
client.opacity = client.opacity*0.5;
</syntaxhighlight>

== Workspace ==
=== Methods ===
The following methods have been renamed as properties:
* '''dimensions()''' -> '''displaySize'''
* '''desktopGridSize()''' -> '''desktopGridSize'''
* '''activeClient()''' -> '''activeClient'''

The following methods have been renamed:
* '''getAllClients()''' -> '''clientList()''', with the addition that sorting for desktop is no longer provided

The following methods have been removed:
* '''clientGroups'''

== Toplevel ==
All methods are available as properties with the same name as the getter methods in the old API except '''hasAlpha''' which is just '''alpha'''.

== Client ==
=== Methods ===
The following methods are no longer available:
* '''move()''': use the '''geometry''' property
* '''resize()''': use the '''geometry''' property
* '''getWindowInfo()''': properties of WindowInfo are merged into Toplevel and Client. See notes to WindowInfo.
* '''activate()''': use workspace.activateClient() (TODO: currently not yet available)
* '''setCaption()''': caption cannot be updated through JavaScript. This was an incorrect exported method. Use XProperties
* '''unminimize()''': set '''minimized''' property to ''false''.

The following methods have been renamed as properties:
* '''isTransient()''' -> '''transient'''
* '''isTransientFor()''' -> '''transientFor'''
* '''isShade()''' -> '''shade'''
* '''isShadeable()''' -> '''shadeable'''
* '''isMinimized()''' -> '''minimized'''
* '''isMinimizable()''' -> '''minimizable'''
* '''isMaximizable()''' -> '''maximizable'''
* '''isResizable()''' -> '''resizeable'''
* '''isMovable()''' -> '''moveable'''
* '''isMovableAcrossScreens()''' -> '''moveableAcrossScreens'''
* '''isCloseable()''' -> '''closeable'''
* '''isFullScreen()/setFullScreen()''' -> '''fullScreen'''
* '''isFullScreenable()''' -> '''fullScreenable'''

The following methods have been renamed:
* '''close()''' -> '''closeWindow()'''

=== Events ===
The events are documented as ''Signals'' in the new documentation. The new API follows the pattern of emitting a signal whenever a value changes. Use the property to query the new value. If the old value is required you should save the state in your script.

The following signals have been renamed:
* '''clientMoved''' -> '''geometryChanged'''
* '''minimized''' -> '''minimizedChanged'''
* '''activated''' -> '''activeChanged'''
* '''unminimized''' -> '''minimizedChanged'''
* '''fullScreenSet''' -> '''fullScreenChanged'''

== ClientGroup ==
ClientGroup is no longer available. Have a look at the tab* methods on Client.

== WindowInfo ==
WindowInfo is no longer provided. All relevant properties are merged into Toplevel or Client.

=== Moved Properties ===
* '''isMinimized''' -> '''Client.minimized'''
* '''windowRole''' -> '''Toplevel.windowRole'''
* '''windowClassClass''' -> '''Toplevel.resourceClass'''
* '''windowClassName''' -> '''Toplevel.resourceName'''

=== Dropped Properties ===
* '''isValid'''
* '''visibleName''': best match '''Client.caption'''
* '''state''': use better properties on Toplevel and Client

Development/Tutorials/KWin/Scripting/API 4.9

2012-03-06T07:07:33Z

Mgraesslin: /* KWin::ClientGroup */

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *, int)'''
* '''currentDesktopChanged(int)'''
* '''clientAdded(KWin::Client *)'''
* '''clientRemoved(KWin::Client *)'''
* '''clientManaging(KWin::Client *)'''
* '''clientMinimized(KWin::Client *)'''
* '''clientUnminimized(KWin::Client *)'''
* '''clientRestored(KWin::Client *)'''
* '''clientMaximizeSet(KWin::Client *, bool, bool)'''
* '''killWindowCalled(KWin::Client *)'''
* '''clientActivated(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientSetKeepAbove(KWin::Client *, bool)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const '''
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::TabGroup ==

=== Read-only Properties ===

=== Read-write Properties ===

=== Signals ===

* '''minSizeChanged()'''
* '''maxSizeChanged()'''
=== Functions ===

Development/Tutorials/KWin/Scripting/API 4.9

2012-03-06T07:06:22Z

Mgraesslin: /* KWin::Client */

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *, int)'''
* '''currentDesktopChanged(int)'''
* '''clientAdded(KWin::Client *)'''
* '''clientRemoved(KWin::Client *)'''
* '''clientManaging(KWin::Client *)'''
* '''clientMinimized(KWin::Client *)'''
* '''clientUnminimized(KWin::Client *)'''
* '''clientRestored(KWin::Client *)'''
* '''clientMaximizeSet(KWin::Client *, bool, bool)'''
* '''killWindowCalled(KWin::Client *)'''
* '''clientActivated(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientSetKeepAbove(KWin::Client *, bool)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const '''
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::TabGroup'' '''tabGroup''': The "Window Tabs" Group this Client belongs to.
* ''bool'' '''isCurrentTab''': Whether this Client is the currently visible Client in its Client Group (Window Tabs). For change connect to the visibleChanged signal on the Client's Group.
* ''QSize'' '''minSize''': Minimum size as specified in WM_NORMAL_HINTS
* ''QSize'' '''maxSize''': Maximum size as specified in WM_NORMAL_HINTS
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
* ''bool'' '''skipTaskbar''': Indicates that the window should not be included on a taskbar.
* ''bool'' '''skipPager''': Indicates that the window should not be included on a Pager.
* ''bool'' '''noBorder''': Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMaximizedStateChanged(KWin::Client *c, bool h, bool v)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''skipTaskbarChanged()'''
* '''skipPagerChanged()'''
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.
=== Functions ===

* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.
* ''Q_INVOKABLE bool'' '''tabBefore(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''tabBehind(Client *other, bool activate)'''
* ''Q_INVOKABLE bool'' '''untab(const QRect &toGeometry=QRect())'''

== KWin::ClientGroup ==

=== Read-only Properties ===

* ''QSize'' '''minSize''': Combined minimum size of all clients in the group.
* ''QSize'' '''maxSize''': Combined maximum size of all clients in the group.
* ''int'' '''visibleClientIndex''': The index of the visible Client in this group.
* ''QList<KWin::Client*>'' '''clients''': The Clients in this group.
=== Read-write Properties ===

* ''KWin::Client'' '''visible''': Currently visible client in this group.
=== Signals ===

* '''visibleChanged()''': Emitted when the visible Client in this group changes.
* '''minSizeChanged()''': Emitted when the group's minimum size changes.
* '''maxSizeChanged()''': Emitted when the group's maximum size changes.
=== Functions ===

* '''add(KWin::Client *c, int before=-1, bool becomeVisible=false)''': Adds c to the group before before in the list. If becomeVisible is true then the added client will become also the visible client.
* '''remove(int index, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove the client at index index from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''remove(KWin::Client *c, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove c from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''removeAll()''': Remove all clients from this group. Results in all clients except the first being moved to a group of their own.
* '''closeAll()''': Close all clients in this group.
* '''move(int index, int before)''': Move the client at index index to the position before the client at index before in the list.
* '''move(KWin::Client *c, KWin::Client *before)''': Move c to the position before before in the list.
* '''displayClientMenu(int index, const QPoint &pos)''': Display the right-click client menu belonging to the client at index index at the global coordinates specified by pos.
* '''displayClientMenu(KWin::Client *c, const QPoint &pos)''': Display the right-click client menu belonging to c at the global coordinates specified by pos.
* ''int'' '''indexOfClient(KWin::Client *c)''': Returns the list index of c.
* ''bool'' '''contains(KWin::Client *c)''': Returns whether or not this group contains c.

Development/Tutorials/KWin/Scripting/API 4.9

2012-03-06T07:05:27Z

Mgraesslin: /* KWin::Toplevel */

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *, int)'''
* '''currentDesktopChanged(int)'''
* '''clientAdded(KWin::Client *)'''
* '''clientRemoved(KWin::Client *)'''
* '''clientManaging(KWin::Client *)'''
* '''clientMinimized(KWin::Client *)'''
* '''clientUnminimized(KWin::Client *)'''
* '''clientRestored(KWin::Client *)'''
* '''clientMaximizeSet(KWin::Client *, bool, bool)'''
* '''killWindowCalled(KWin::Client *)'''
* '''clientActivated(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientSetKeepAbove(KWin::Client *, bool)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const '''
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''': Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''
* ''bool'' '''managed''': Whether this Toplevel is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).
* ''bool'' '''deleted''': Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
* ''bool'' '''shaped''': Whether the window has an own shape
=== Read-write Properties ===

* ''qreal'' '''opacity'''
=== Signals ===

* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''
* '''windowShown(KWin::Toplevel *toplevel)'''
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration.
=== Functions ===

* ''Q_INVOKABLE void'' '''addRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRect &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(const QRegion &r)'''
* ''Q_INVOKABLE void'' '''addLayerRepaint(int x, int y, int w, int h)'''
* ''Q_INVOKABLE void'' '''addRepaintFull()'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::ClientGroup'' '''clientGroup''': The "Window Tabs" Group this Client belongs to.
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''s_unminimized()'''
* '''maximizeSet(QPair< bool, bool >)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''clientGroupChanged()''': Emitted whenever the Client's ClientGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.

=== Functions ===
* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.

== KWin::ClientGroup ==

=== Read-only Properties ===

* ''QSize'' '''minSize''': Combined minimum size of all clients in the group.
* ''QSize'' '''maxSize''': Combined maximum size of all clients in the group.
* ''int'' '''visibleClientIndex''': The index of the visible Client in this group.
* ''QList<KWin::Client*>'' '''clients''': The Clients in this group.
=== Read-write Properties ===

* ''KWin::Client'' '''visible''': Currently visible client in this group.
=== Signals ===

* '''visibleChanged()''': Emitted when the visible Client in this group changes.
* '''minSizeChanged()''': Emitted when the group's minimum size changes.
* '''maxSizeChanged()''': Emitted when the group's maximum size changes.
=== Functions ===

* '''add(KWin::Client *c, int before=-1, bool becomeVisible=false)''': Adds c to the group before before in the list. If becomeVisible is true then the added client will become also the visible client.
* '''remove(int index, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove the client at index index from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''remove(KWin::Client *c, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove c from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''removeAll()''': Remove all clients from this group. Results in all clients except the first being moved to a group of their own.
* '''closeAll()''': Close all clients in this group.
* '''move(int index, int before)''': Move the client at index index to the position before the client at index before in the list.
* '''move(KWin::Client *c, KWin::Client *before)''': Move c to the position before before in the list.
* '''displayClientMenu(int index, const QPoint &pos)''': Display the right-click client menu belonging to the client at index index at the global coordinates specified by pos.
* '''displayClientMenu(KWin::Client *c, const QPoint &pos)''': Display the right-click client menu belonging to c at the global coordinates specified by pos.
* ''int'' '''indexOfClient(KWin::Client *c)''': Returns the list index of c.
* ''bool'' '''contains(KWin::Client *c)''': Returns whether or not this group contains c.

Development/Tutorials/KWin/Scripting/API 4.9

2012-03-06T07:04:23Z

Mgraesslin: /* Workspace */

== Workspace ==
Workspace is the global object injected into each script as '''workspace'''. It provides access to core functionality of the window manager.

=== Read-only Properties ===

* ''QSize'' '''desktopGridSize'''
* ''int'' '''desktopGridWidth'''
* ''int'' '''desktopGridHeight'''
* ''int'' '''workspaceWidth'''
* ''int'' '''workspaceHeight'''
* ''QSize'' '''workspaceSize'''
* ''QSize'' '''displaySize''': The same of the display, that is all screens.
* ''int'' '''displayWidth''': The width of the display, that is width of all combined screens.
* ''int'' '''displayHeight''': The height of the display, that is height of all combined screens.
* ''int'' '''activeScreen'''
* ''int'' '''numScreens'''
=== Read-write Properties ===

* ''int'' '''currentDesktop'''
* ''KWin::Client'' '''activeClient'''
* ''int'' '''desktops''': The number of desktops currently used. Minimum number of desktops is 1, maximum 20.
=== Signals ===

* '''desktopPresenceChanged(KWin::Client *, int)'''
* '''currentDesktopChanged(int)'''
* '''clientAdded(KWin::Client *)'''
* '''clientRemoved(KWin::Client *)'''
* '''clientManaging(KWin::Client *)'''
* '''clientMinimized(KWin::Client *)'''
* '''clientUnminimized(KWin::Client *)'''
* '''clientRestored(KWin::Client *)'''
* '''clientMaximizeSet(KWin::Client *, bool, bool)'''
* '''killWindowCalled(KWin::Client *)'''
* '''clientActivated(KWin::Client *)'''
* '''clientFullScreenSet(KWin::Client *, bool, bool)'''
* '''clientSetKeepAbove(KWin::Client *, bool)'''
* '''numberDesktopsChanged(int oldNumberOfDesktops)''': Signal emitted whenever the number of desktops changed. To get the current number of desktops use the property desktops. oldNumberOfDesktops The previous number of desktops.
=== Functions ===

* '''slotSwitchDesktopNext()'''
* '''slotSwitchDesktopPrevious()'''
* '''slotSwitchDesktopRight()'''
* '''slotSwitchDesktopLeft()'''
* '''slotSwitchDesktopUp()'''
* '''slotSwitchDesktopDown()'''
* '''slotSwitchToNextScreen()'''
* '''slotWindowToNextScreen()'''
* '''slotToggleShowDesktop()'''
* '''slotWindowMaximize()'''
* '''slotWindowMaximizeVertical()'''
* '''slotWindowMaximizeHorizontal()'''
* '''slotWindowMinimize()'''
* '''slotWindowShade()'''
* '''slotWindowRaise()'''
* '''slotWindowLower()'''
* '''slotWindowRaiseOrLower()'''
* '''slotActivateAttentionWindow()'''
* '''slotWindowPackLeft()'''
* '''slotWindowPackRight()'''
* '''slotWindowPackUp()'''
* '''slotWindowPackDown()'''
* '''slotWindowGrowHorizontal()'''
* '''slotWindowGrowVertical()'''
* '''slotWindowShrinkHorizontal()'''
* '''slotWindowShrinkVertical()'''
* '''slotWindowQuickTileLeft()'''
* '''slotWindowQuickTileRight()'''
* '''slotWindowQuickTileTopLeft()'''
* '''slotWindowQuickTileTopRight()'''
* '''slotWindowQuickTileBottomLeft()'''
* '''slotWindowQuickTileBottomRight()'''
* '''slotSwitchWindowUp()'''
* '''slotSwitchWindowDown()'''
* '''slotSwitchWindowRight()'''
* '''slotSwitchWindowLeft()'''
* '''slotIncreaseWindowOpacity()'''
* '''slotLowerWindowOpacity()'''
* '''slotWindowOperations()'''
* '''slotWindowClose()'''
* '''slotWindowMove()'''
* '''slotWindowResize()'''
* '''slotWindowAbove()'''
* '''slotWindowBelow()'''
* '''slotWindowOnAllDesktops()'''
* '''slotWindowFullScreen()'''
* '''slotWindowNoBorder()'''
* '''slotWindowToNextDesktop()'''
* '''slotWindowToPreviousDesktop()'''
* '''slotWindowToDesktopRight()'''
* '''slotWindowToDesktopLeft()'''
* '''slotWindowToDesktopUp()'''
* '''slotWindowToDesktopDown()'''
* ''Q_INVOKABLE QList< KWin::Client * >'' '''clientList() const '''
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry
* ''QRect'' '''clientArea(ClientAreaOption option, const Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop.
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance.

== KWin::Toplevel ==
Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.
=== Read-only Properties ===
* ''bool'' '''alpha'''
* ''qulonglong'' '''frameId'''
* ''QRect'' '''geometry'''
* ''int'' '''height'''
* ''QPoint'' '''pos'''
* ''int'' '''screen'''
* ''QSize'' '''size'''
* ''int'' '''width'''
* ''qulonglong'' '''windowId'''
* ''int'' '''x'''
* ''int'' '''y'''
* ''int'' '''desktop'''
* ''QRect'' '''rect'''
* ''QPoint'' '''clientPos'''
* ''QSize'' '''clientSize'''
* ''QByteArray'' '''resourceName'''
* ''QByteArray'' '''resourceClass'''
* ''QByteArray'' '''windowRole'''
* ''bool'' '''desktopWindow''': Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dock''': Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''toolbar''': Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''menu''': Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''normalWindow''': Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dialog''': Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''splash''': Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''utility''':Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dropdownMenu''': Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the applications menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''popupMenu''': Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''tooltip''': Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
* ''QStringList'' '''activities'''

=== Read-write Properties ===
* ''qreal'' '''opacity''':

=== Signals ===
* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)'''
* '''damaged(KWin::Toplevel *toplevel, const QRect &damage)'''
* '''propertyNotify(KWin::Toplevel *toplevel, long a)'''
* '''geometryChanged()'''
* '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)'''
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)'''

== KWin::Client ==
The Client class encapsulates a window decoration frame.
'''Inherits:''' KWin::Toplevel
=== Read-only Properties ===

* ''bool'' '''active''': Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
* ''QString'' '''caption''': The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.
* ''bool'' '''closeable''': Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''fullScreenable''': Whether the Client can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''maximizable''': Whether the Client can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''minimizable''': Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''modal''': Whether the Client represents a modal window.
* ''bool'' '''moveable''': Whether the Client is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveableAcrossScreens
* ''bool'' '''moveableAcrossScreens''': Whether the Client can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal. moveable
* ''bool'' '''providesContextHelp''': Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()
* ''bool'' '''resizeable''': Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''shadeable''': Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
* ''bool'' '''transient''': Whether the Client is a transient Window to another Window. transientFor
* ''KWin::Client'' '''transientFor''': The Client to which this Client is a transient if any.
* ''QSize'' '''basicUnit''': By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''move''': Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''bool'' '''resize''': Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
* ''QRect'' '''iconGeometry''': The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''specialWindow''': Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''bool'' '''wantsInput''': Whether the Client can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.
* ''QPixmap'' '''icon'''
* ''KWin::ClientGroup'' '''clientGroup''': The "Window Tabs" Group this Client belongs to.
=== Read-write Properties ===

* ''int'' '''desktop''': The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.
* ''bool'' '''fullScreen''': Whether this Client is fullScreen. A Client might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.
* ''QRect'' '''geometry''': The geometry of this Client. Be aware that depending on resize mode the geometryChanged signal might be emitted at each resize step or only at the end of the resize operation.
* ''bool'' '''keepAbove''': Whether the Client is set to be kept above other windows.
* ''bool'' '''keepBelow''': Whether the Client is set to be kept below other windows.
* ''bool'' '''minimized''': Whether the Client is minimized.
* ''bool'' '''shade''': Whether the Client is shaded.
* ''bool'' '''skipSwitcher''': Whether the Client should be excluded from window switching effects.
=== Signals ===

* '''clientManaging(KWin::Client *)'''
* '''s_unminimized()'''
* '''maximizeSet(QPair< bool, bool >)'''
* '''clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)'''
* '''clientMinimized(KWin::Client *client, bool animate)'''
* '''clientUnminimized(KWin::Client *client, bool animate)'''
* '''clientStartUserMovedResized(KWin::Client *)'''
* '''clientStepUserMovedResized(KWin::Client *, const QRect &)'''
* '''clientFinishUserMovedResized(KWin::Client *)'''
* '''activeChanged()'''
* '''captionChanged()'''
* '''desktopChanged()'''
* '''fullScreenChanged()'''
* '''transientChanged()'''
* '''modalChanged()'''
* '''shadeChanged()'''
* '''keepAboveChanged()'''
* '''keepBelowChanged()'''
* '''minimizedChanged()'''
* '''moveResizedChanged()'''
* '''iconChanged()'''
* '''skipSwitcherChanged()'''
* '''clientGroupChanged()''': Emitted whenever the Client's ClientGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.

=== Functions ===
* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill.

== KWin::ClientGroup ==

=== Read-only Properties ===

* ''QSize'' '''minSize''': Combined minimum size of all clients in the group.
* ''QSize'' '''maxSize''': Combined maximum size of all clients in the group.
* ''int'' '''visibleClientIndex''': The index of the visible Client in this group.
* ''QList<KWin::Client*>'' '''clients''': The Clients in this group.
=== Read-write Properties ===

* ''KWin::Client'' '''visible''': Currently visible client in this group.
=== Signals ===

* '''visibleChanged()''': Emitted when the visible Client in this group changes.
* '''minSizeChanged()''': Emitted when the group's minimum size changes.
* '''maxSizeChanged()''': Emitted when the group's maximum size changes.
=== Functions ===

* '''add(KWin::Client *c, int before=-1, bool becomeVisible=false)''': Adds c to the group before before in the list. If becomeVisible is true then the added client will become also the visible client.
* '''remove(int index, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove the client at index index from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''remove(KWin::Client *c, const QRect &newGeom=QRect(), bool toNullGroup=false)''': Remove c from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.
* '''removeAll()''': Remove all clients from this group. Results in all clients except the first being moved to a group of their own.
* '''closeAll()''': Close all clients in this group.
* '''move(int index, int before)''': Move the client at index index to the position before the client at index before in the list.
* '''move(KWin::Client *c, KWin::Client *before)''': Move c to the position before before in the list.
* '''displayClientMenu(int index, const QPoint &pos)''': Display the right-click client menu belonging to the client at index index at the global coordinates specified by pos.
* '''displayClientMenu(KWin::Client *c, const QPoint &pos)''': Display the right-click client menu belonging to c at the global coordinates specified by pos.
* ''int'' '''indexOfClient(KWin::Client *c)''': Returns the list index of c.
* ''bool'' '''contains(KWin::Client *c)''': Returns whether or not this group contains c.

Development/Tutorials/KWin/Scripting

2012-03-02T07:16:14Z

Mgraesslin: /* KWin Scripting Tutorial */

= KWin Scripting Tutorial =

{{warning|KWin's Scripting functionality has been reworked for KDE Plasma Workspaces 4.9. This tutorial does not cover the previous API. In case you had an existing script, please consult [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes]] for migration note.}}

== Quick Start: Desktop Console ==
The easiest way to test KWin scripts is to use the Plasma Desktop Scripting Console which can be opened via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "wm console" as the search term It can be triggered directly via dbus with <syntaxhighlight lang="bash">qdbus org.kde.plasma-desktop /MainApplication showInteractiveKWinConsole</syntaxhighlight>

{{note|This method is not available for plasma-netbook.}}

The interactive console allows to send a script to the window manager which is directly loaded and executed. All debug output is displayed in the scripting console. This provides a very easy way to develop and test the script to be written. It is important to know that scripts executed from the scripting console are only used by the window manager as long as the window manager is running. In a new session the script has to be sent to the window manager again.

== Packaging KWin Scripts ==
In order to have KWin load a script on each session start the script has to be packaged. KWin Scripts use the [[Development/Tutorials/Plasma/PackageOverview|Plasma Package]] format. The recommended file ending for KWin Script packages is '''.kwinscript'''. In the metadata.desktop file of the package the value for "X-KDE-ServiceTypes" has to be '''KWin/Script''', as "X-Plasma-API" only '''javascript''' and '''declarativescript''' are supported.

A packaged KWin Script can either be installed via the KWin Script KCM (note: the list does not yet reload after installing a script) or with the plasmapkg tool: <syntaxhighlight lang="bash">plasmapkg --type kwinscript -i /path/to/myscript.kwinscript</syntaxhighlight>

After installation the script has to be enabled in the KWin Script KCM. The window manager will load the newly installed script directly at runtime as well as in new sessions.

== Where can I find example scripts? ==
A few KWin Scripts are shipped directly with the window manager. You can find those in your system installation. Just use plasmapkg to get a list of the available scripts:
<syntaxhighlight lang="bash">
plasmapkg -t kwinscript -l
</syntaxhighlight>

The scripts can be found in the data install path of your local KDE installation under "kwin/scripts". E.g. in '''~/.kde/share/apps/kwin/scripts/'''.

Additionally you can find the scripts in the [https://projects.kde.org/projects/kde/kde-workspace/repository/revisions/master/show/kwin/scripts KDE-Workspace repository] and some example scripts in the [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/kwin/scripts KDE Examples repository].

== KWin scripting basics ==

To follow this tutorial, you must have some idea about [http://en.wikipedia.org/wiki/ECMAScript ECMAScript] (or [http://en.wikipedia.org/wiki/JavaScript JavaScript]. A quick introduction can be found in the [http://techbase.kde.org/Development/Tutorials/Plasma#JavaScript Plasma scripting tutorial].

KWin Scripts can either be written in [https://qt-project.org/doc/qt-4.8/scripting.html QtScript] (service type "javascript") or [https://qt-project.org/doc/qt-4.8/qdeclarativeintroduction.html QML] (service type "declarativescript"). In order to develop KWin Scripts you should know the basic concepts of signals and properties.

=== Global Objects and Functions ===

KWin Scripts can access two global properties '''workspace''' and '''options'''. The workspace object provides the interface to the core of the window manager, the options object provides read access to the current configuration options set on the window manager. To get an overview of what is available, please refer to the [[Development/Tutorials/KWin/Scripting/API_4.9|API documentation]].

The following global functions are available to both QML and QtScript:
* '''print(QVariant...)''': prints the provided arguments to stdout. Takes an arbitrary number of arguments. Comparable to console.log() which should be preferred in QML scripts.
* '''readConfig(QString key, QVariant defaultValue=QVariant())''': reads a config option of the KWin Script. First argument is the config key, second argument is an optional default value in case the config key does not exist in the config file.

=== Clients ===
The window manager calls a window it manages a "Client". Most methods of workspace operating on windows either return a Client or require a Client. Internally the window manager supports more types of windows, which are not clients. Those windows are not available for KWin Scripts, but for KWin Effects. To have a common set of properties some properties and signals are defined on the parent class of Client called '''Toplevel'''. Be sure to check the documentation of that class, too when looking for properties. Be aware that some properties are defined as read-only on Toplevel, but as read-write on Client.

The following examples illustrates how to get hold of all clients managed by the window manager and prints the clients' caption:
<syntaxhighlight lang="javascript">
var clients = workspace.clientList();
for (var i=0; i<clients.length; i++) {
print(clients[i].caption);
}
</syntaxhighlight>

The following example illustrates how to get informed about newly managed clients and prints out the window id of the new client:
<syntaxhighlight lang="javascript">
workspace.clientAdded.connect(function(client) {
print(client.windowId);
});
</syntaxhighlight>
To understand which parameters are passed to the event handlers (i.e. the functions we connect to), one can always refer the [[Development/Tutorials/KWin/Scripting/API]].

== Your first (useful) script ==

In this tutorial we will be creating a script based on a suggestion by Eike Hein. In Eike’s words: ''“A quick use case question: For many years I’ve desired the behavior of disabling keep-above on a window with keep-above enabled when it is maximized, and re-enabling keep-above when it is restored. Is that be possible with kwin scripting? It’ll need the ability to trigger methods on state changes and store information above a specific window across those state changes, I guess.”''

Other than the really function and useful script idea, what is really great about this is that it makes for a perfect tutorial example. I get to cover most of the important aspects of KWin scripting while at the same time creating something useful.

So let’s get on with it…

=== The basic outline ===
'''Design statement''': For every window that is set to '''‘Keep Above’''' others, the window should not be above all windows when it is maximized.

To do so, this is how we’ll proceed:
#Create an array of clients whose '''‘Keep Above’''' property has been removed for maximized windows
#Whenever a client is maximized, if it’s ''''‘Keep Above’''' property is set, remove the '''‘Keep Above’''' property.
#Whenever a client is restored, if it is in the ‘array’, set it’s '''‘Keep Above’''' property.

==== The basic framework ====
So, for first steps, let us just create an array:
<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();
</syntaxhighlight>

Now we need to know whenever a window got maximized. There are two approaches to achieve that: either connect to a signal emitted on the workspace object or to a signal of the client. As we need to track all Clients it is easier to just use the signal '''clientMaximizeSet'' on the workspace. This signal is emitted whenever the maximization state of a Client changes and passes the client and two boolean flags to the callback. The flags indicate whether the Client is maximized horizontally and/or vertically. If a client is maximized both horizontally and vertically it is considered as fully maximized. Let's try it:

<syntaxhighlight lang=javascript>
workspace.clientMaximizeSet.connect(function(client, h, v) {
if (h && v) {
print(client.caption + " is fully maximized");
} else {
print(client.caption + " is not maximized");
}
});
</syntaxhighlight>

Best give the script a try in the desktop scripting console and play with your windows. Remember right and middle clicking the maximize button changes the horizontal/vertical state of the window.

==== Checking keep above ====
Now we actually want to do something with the maximized Client. We need to check whether the window is set as keep above. If it is so, we need to remove the keep above state and remember that we modified the Client. For better readability the callback is moved into an own method:

<syntaxhighlight lang=javascript>
function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
}
}
</syntaxhighlight>
This code checks whether the window is maximized, if that is the case we access the Client's '''keepAbove''' property which is a boolean. If the Client is keep above we append the Client to our global array '''keepAboveMaximized''' of Clients we modified. This is important to be able to reset the keep above state when the window gets restored again.

Last but not least we have to remove keep above which is a simple assignment to the Client's property. If you want to test it in the desktop scripting console remember to adjust the signal connection:

<syntaxhighlight lang=javascript>
workspace.clientMaximizeSet.connect(manageKeepAbove);
</syntaxhighlight>

==== Restoring it all ====

Now the last and most important part of it all. Whenver the client is restored, we must set it’s '''‘Keep Above’''' property if it was set earlier. To do this, we must simply extend our '''manageKeepAbove''' code to handle this scenario. In case the client is not maximized both vertically and horizontally, we check if the client is in our '''keepAboveMaximized''' arrray and if it is, we set its '''‘Keep Above’''' property, otherwise we don’t bother:

<syntaxhighlight lang=javascript>
function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}
</syntaxhighlight>

In the end, our entire script looks like:

<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();

function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}

workspace.clientMaximizeSet.connect(manageKeepAbove);
</syntaxhighlight>

The script in Plasma Package structure can be found in the [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/kwin/scripts/keepaboverestored kde-examples repository].

=== What next? ===
The script is of course very simple. It does not take care of windows which are already present when the window manager starts. It might be an idea to restrict the script to some window classes (e.g. video players). It's up to you.

Development/Tutorials/KWin/Scripting

2012-03-02T07:06:20Z

Mgraesslin: /* The basic outline */

= KWin Scripting Tutorial =

{{warning|KWin's Scripting functionality has been reworked for KDE Plasma Workspaces 4.9. This tutorial does not cover the previous API. In case you had an existing script, please consult [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes]] for migration note.}}

== Quick Start: Desktop Console ==
The easiest way to test KWin scripts is to use the Plasma Desktop Scripting Console which can be opened via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "wm console" as the search term It can be triggered directly via dbus with <syntaxhighlight lang="bash">qdbus org.kde.plasma-desktop /MainApplication showInteractiveKWinConsole</syntaxhighlight>

{{note|This method is not available for plasma-netbook.}}

The interactive console allows to send a script to the window manager which is directly loaded and executed. All debug output is displayed in the scripting console. This provides a very easy way to develop and test the script to be written. It is important to know that scripts executed from the scripting console are only used by the window manager as long as the window manager is running. In a new session the script has to be sent to the window manager again.

== Packaging KWin Scripts ==
In order to have KWin load a script on each session start the script has to be packaged. KWin Scripts use the [[Development/Tutorials/Plasma/PackageOverview|Plasma Package]] format. The recommended file ending for KWin Script packages is '''.kwinscript'''. In the metadata.desktop file of the package the value for "X-KDE-ServiceTypes" has to be '''KWin/Script''', as "X-Plasma-API" only '''javascript''' and '''declarativescript''' are supported.

A packaged KWin Script can either be installed via the KWin Script KCM (note: the list does not yet reload after installing a script) or with the plasmapkg tool: <syntaxhighlight lang="bash">plasmapkg --type kwinscript -i /path/to/myscript.kwinscript</syntaxhighlight>

After installation the script has to be enabled in the KWin Script KCM. The window manager will load the newly installed script directly at runtime as well as in new sessions.

== KWin scripting basics ==

To follow this tutorial, you must have some idea about [http://en.wikipedia.org/wiki/ECMAScript ECMAScript] (or [http://en.wikipedia.org/wiki/JavaScript JavaScript]. A quick introduction can be found in the [http://techbase.kde.org/Development/Tutorials/Plasma#JavaScript Plasma scripting tutorial].

KWin Scripts can either be written in [https://qt-project.org/doc/qt-4.8/scripting.html QtScript] (service type "javascript") or [https://qt-project.org/doc/qt-4.8/qdeclarativeintroduction.html QML] (service type "declarativescript"). In order to develop KWin Scripts you should know the basic concepts of signals and properties.

=== Global Objects and Functions ===

KWin Scripts can access two global properties '''workspace''' and '''options'''. The workspace object provides the interface to the core of the window manager, the options object provides read access to the current configuration options set on the window manager. To get an overview of what is available, please refer to the [[Development/Tutorials/KWin/Scripting/API_4.9|API documentation]].

The following global functions are available to both QML and QtScript:
* '''print(QVariant...)''': prints the provided arguments to stdout. Takes an arbitrary number of arguments. Comparable to console.log() which should be preferred in QML scripts.
* '''readConfig(QString key, QVariant defaultValue=QVariant())''': reads a config option of the KWin Script. First argument is the config key, second argument is an optional default value in case the config key does not exist in the config file.

=== Clients ===
The window manager calls a window it manages a "Client". Most methods of workspace operating on windows either return a Client or require a Client. Internally the window manager supports more types of windows, which are not clients. Those windows are not available for KWin Scripts, but for KWin Effects. To have a common set of properties some properties and signals are defined on the parent class of Client called '''Toplevel'''. Be sure to check the documentation of that class, too when looking for properties. Be aware that some properties are defined as read-only on Toplevel, but as read-write on Client.

The following examples illustrates how to get hold of all clients managed by the window manager and prints the clients' caption:
<syntaxhighlight lang="javascript">
var clients = workspace.clientList();
for (var i=0; i<clients.length; i++) {
print(clients[i].caption);
}
</syntaxhighlight>

The following example illustrates how to get informed about newly managed clients and prints out the window id of the new client:
<syntaxhighlight lang="javascript">
workspace.clientAdded.connect(function(client) {
print(client.windowId);
});
</syntaxhighlight>
To understand which parameters are passed to the event handlers (i.e. the functions we connect to), one can always refer the [[Development/Tutorials/KWin/Scripting/API]].

== Your first (useful) script ==

In this tutorial we will be creating a script based on a suggestion by Eike Hein. In Eike’s words: ''“A quick use case question: For many years I’ve desired the behavior of disabling keep-above on a window with keep-above enabled when it is maximized, and re-enabling keep-above when it is restored. Is that be possible with kwin scripting? It’ll need the ability to trigger methods on state changes and store information above a specific window across those state changes, I guess.”''

Other than the really function and useful script idea, what is really great about this is that it makes for a perfect tutorial example. I get to cover most of the important aspects of KWin scripting while at the same time creating something useful.

So let’s get on with it…

=== The basic outline ===
'''Design statement''': For every window that is set to '''‘Keep Above’''' others, the window should not be above all windows when it is maximized.

To do so, this is how we’ll proceed:
#Create an array of clients whose '''‘Keep Above’''' property has been removed for maximized windows
#Whenever a client is maximized, if it’s ''''‘Keep Above’''' property is set, remove the '''‘Keep Above’''' property.
#Whenever a client is restored, if it is in the ‘array’, set it’s '''‘Keep Above’''' property.

==== The basic framework ====
So, for first steps, let us just create an array:
<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();
</syntaxhighlight>

Now we need to know whenever a window got maximized. There are two approaches to achieve that: either connect to a signal emitted on the workspace object or to a signal of the client. As we need to track all Clients it is easier to just use the signal '''clientMaximizeSet'' on the workspace. This signal is emitted whenever the maximization state of a Client changes and passes the client and two boolean flags to the callback. The flags indicate whether the Client is maximized horizontally and/or vertically. If a client is maximized both horizontally and vertically it is considered as fully maximized. Let's try it:

<syntaxhighlight lang=javascript>
workspace.clientMaximizeSet.connect(function(client, h, v) {
if (h && v) {
print(client.caption + " is fully maximized");
} else {
print(client.caption + " is not maximized");
}
});
</syntaxhighlight>

Best give the script a try in the desktop scripting console and play with your windows. Remember right and middle clicking the maximize button changes the horizontal/vertical state of the window.

==== Checking keep above ====
Now we actually want to do something with the maximized Client. We need to check whether the window is set as keep above. If it is so, we need to remove the keep above state and remember that we modified the Client. For better readability the callback is moved into an own method:

<syntaxhighlight lang=javascript>
function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
}
}
</syntaxhighlight>
This code checks whether the window is maximized, if that is the case we access the Client's '''keepAbove''' property which is a boolean. If the Client is keep above we append the Client to our global array '''keepAboveMaximized''' of Clients we modified. This is important to be able to reset the keep above state when the window gets restored again.

Last but not least we have to remove keep above which is a simple assignment to the Client's property. If you want to test it in the desktop scripting console remember to adjust the signal connection:

<syntaxhighlight lang=javascript>
workspace.clientMaximizeSet.connect(manageKeepAbove);
</syntaxhighlight>

==== Restoring it all ====

Now the last and most important part of it all. Whenver the client is restored, we must set it’s '''‘Keep Above’''' property if it was set earlier. To do this, we must simply extend our '''manageKeepAbove''' code to handle this scenario. In case the client is not maximized both vertically and horizontally, we check if the client is in our '''keepAboveMaximized''' arrray and if it is, we set its '''‘Keep Above’''' property, otherwise we don’t bother:

<syntaxhighlight lang=javascript>
function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}
</syntaxhighlight>

In the end, our entire script looks like:

<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();

function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}

workspace.clientMaximizeSet.connect(manageKeepAbove);
</syntaxhighlight>

The script in Plasma Package structure can be found in the [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/kwin/scripts/keepaboverestored kde-examples repository].

=== What next? ===
The script is of course very simple. It does not take care of windows which are already present when the window manager starts. It might be an idea to restrict the script to some window classes (e.g. video players). It's up to you.

Development/Tutorials/KWin/Scripting

2012-03-02T06:55:40Z

Mgraesslin: /* The basic outline */

= KWin Scripting Tutorial =

{{warning|KWin's Scripting functionality has been reworked for KDE Plasma Workspaces 4.9. This tutorial does not cover the previous API. In case you had an existing script, please consult [[Projects/KWin/Scripting_Update_Notes|Scripting Update Notes]] for migration note.}}

== Quick Start: Desktop Console ==
The easiest way to test KWin scripts is to use the Plasma Desktop Scripting Console which can be opened via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "wm console" as the search term It can be triggered directly via dbus with <syntaxhighlight lang="bash">qdbus org.kde.plasma-desktop /MainApplication showInteractiveKWinConsole</syntaxhighlight>

{{note|This method is not available for plasma-netbook.}}

The interactive console allows to send a script to the window manager which is directly loaded and executed. All debug output is displayed in the scripting console. This provides a very easy way to develop and test the script to be written. It is important to know that scripts executed from the scripting console are only used by the window manager as long as the window manager is running. In a new session the script has to be sent to the window manager again.

== Packaging KWin Scripts ==
In order to have KWin load a script on each session start the script has to be packaged. KWin Scripts use the [[Development/Tutorials/Plasma/PackageOverview|Plasma Package]] format. The recommended file ending for KWin Script packages is '''.kwinscript'''. In the metadata.desktop file of the package the value for "X-KDE-ServiceTypes" has to be '''KWin/Script''', as "X-Plasma-API" only '''javascript''' and '''declarativescript''' are supported.

A packaged KWin Script can either be installed via the KWin Script KCM (note: the list does not yet reload after installing a script) or with the plasmapkg tool: <syntaxhighlight lang="bash">plasmapkg --type kwinscript -i /path/to/myscript.kwinscript</syntaxhighlight>

After installation the script has to be enabled in the KWin Script KCM. The window manager will load the newly installed script directly at runtime as well as in new sessions.

== KWin scripting basics ==

To follow this tutorial, you must have some idea about [http://en.wikipedia.org/wiki/ECMAScript ECMAScript] (or [http://en.wikipedia.org/wiki/JavaScript JavaScript]. A quick introduction can be found in the [http://techbase.kde.org/Development/Tutorials/Plasma#JavaScript Plasma scripting tutorial].

KWin Scripts can either be written in [https://qt-project.org/doc/qt-4.8/scripting.html QtScript] (service type "javascript") or [https://qt-project.org/doc/qt-4.8/qdeclarativeintroduction.html QML] (service type "declarativescript"). In order to develop KWin Scripts you should know the basic concepts of signals and properties.

=== Global Objects and Functions ===

KWin Scripts can access two global properties '''workspace''' and '''options'''. The workspace object provides the interface to the core of the window manager, the options object provides read access to the current configuration options set on the window manager. To get an overview of what is available, please refer to the [[Development/Tutorials/KWin/Scripting/API_4.9|API documentation]].

The following global functions are available to both QML and QtScript:
* '''print(QVariant...)''': prints the provided arguments to stdout. Takes an arbitrary number of arguments. Comparable to console.log() which should be preferred in QML scripts.
* '''readConfig(QString key, QVariant defaultValue=QVariant())''': reads a config option of the KWin Script. First argument is the config key, second argument is an optional default value in case the config key does not exist in the config file.

=== Clients ===
The window manager calls a window it manages a "Client". Most methods of workspace operating on windows either return a Client or require a Client. Internally the window manager supports more types of windows, which are not clients. Those windows are not available for KWin Scripts, but for KWin Effects. To have a common set of properties some properties and signals are defined on the parent class of Client called '''Toplevel'''. Be sure to check the documentation of that class, too when looking for properties. Be aware that some properties are defined as read-only on Toplevel, but as read-write on Client.

The following examples illustrates how to get hold of all clients managed by the window manager and prints the clients' caption:
<syntaxhighlight lang="javascript">
var clients = workspace.clientList();
for (var i=0; i<clients.length; i++) {
print(clients[i].caption);
}
</syntaxhighlight>

The following example illustrates how to get informed about newly managed clients and prints out the window id of the new client:
<syntaxhighlight lang="javascript">
workspace.clientAdded.connect(function(client) {
print(client.windowId);
});
</syntaxhighlight>
To understand which parameters are passed to the event handlers (i.e. the functions we connect to), one can always refer the [[Development/Tutorials/KWin/Scripting/API]].

== Your first (useful) script ==

In this tutorial we will be creating a script based on a suggestion by Eike Hein. In Eike’s words: ''“A quick use case question: For many years I’ve desired the behavior of disabling keep-above on a window with keep-above enabled when it is maximized, and re-enabling keep-above when it is restored. Is that be possible with kwin scripting? It’ll need the ability to trigger methods on state changes and store information above a specific window across those state changes, I guess.”''

Other than the really function and useful script idea, what is really great about this is that it makes for a perfect tutorial example. I get to cover most of the important aspects of KWin scripting while at the same time creating something useful.

So let’s get on with it…

=== The basic outline ===
'''Design statement''': For every window that is set to '''‘Keep Above’''' others, the window should not be above all windows when it is maximized.

To do so, this is how we’ll proceed:
#Create an array of clients whose '''‘Keep Above’''' property has been removed for maximized windows
#Whenever a client is maximized, if it’s ''''‘Keep Above’''' property is set, remove the '''‘Keep Above’''' property.
#Whenever a client is restored, if it is in the ‘array’, set it’s '''‘Keep Above’''' property.

==== The basic framework ====
So, for first steps, let us just create an array:
<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();
</syntaxhighlight>

Now we need to know whenever a window got maximized. There are two approaches to achieve that: either connect to a signal emitted on the workspace object or to a signal of the client. As we need to track all Clients it is easier to just use the signal '''clientMaximizeSet'' on the workspace. This signal is emitted whenever the maximization state of a Client changes and passes the client and two boolean flags to the callback. The flags indicate whether the Client is maximized horizontally and/or vertically. If a client is maximized both horizontally and vertically it is considered as fully maximized. Let's try it:

<syntaxhighlight lang=javascript>
workspace.clientMaximizeSet.connect(function(client, h, v) {
if (h && v) {
print(client.caption + " is fully maximized");
} else {
print(client.caption + " is not maximized");
}
});
</syntaxhighlight>

Best give the script a try in the desktop scripting console and play with your windows. Remember right and middle clicking the maximize button changes the horizontal/vertical state of the window

==== Restoring it all ====

Now the last and most important part of it all. Whenver the client is restored, we must set it’s '''‘Keep Above’''' property if it was set earlier. To do this, we must simply extend our '''manageKeepAbove''' code to handle this scenario. In case the client is not maximized both vertically and horizontally, we check if the client is in our '''ka_clients''' arrray and if it is, we set its '''‘Keep Above’''' property, otherwise we don’t bother:

<syntaxhighlight lang=javascript>
function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}
</syntaxhighlight>

In the end, our entire script looks like:

<syntaxhighlight lang=javascript>
var keepAboveMaximized = new Array();

function manageKeepAbove(client, h, v) {
if (h && v) {
// maximized
if (client.keepAbove) {
keepAboveMaximized[keepAboveMaximized.length] = client;
client.keepAbove = false;
}
} else {
// no longer maximized
var found = keepAboveMaximized.indexOf(client);
if (found != -1) {
client.keepAbove = true;
keepAboveMaximized.splice(found, 1);
}
}
}

workspace.clientMaximizeSet.connect(manageKeepAbove);
</syntaxhighlight>

The script in Plasma Package structure can be found in the [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/kwin/scripts/keepaboverestored kde-examples repository].