My KWIN fork where I work on features like per-output virtual desktops
Find a file
Volker Krause d920b323bd Follow ECM documentation style
Summary: In preparation for upstreaming to ECM, as qtbase needs this as well.

Reviewers: apol

Reviewed By: apol

Subscribers: kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D18944
2019-02-12 11:56:21 +01:00
autotests [autotests] Test maximize animation 2019-02-01 13:50:40 +02:00
cmake/modules Follow ECM documentation style 2019-02-12 11:56:21 +01:00
colorcorrection Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
data Move icons to data dir 2019-02-06 01:19:54 +02:00
decorations support decorations from lookandfeel 2019-01-16 10:40:54 +01:00
doc [KCMs] move GHNS buttons to the normal location 2018-10-31 07:29:22 -06:00
effects Merge branch 'Plasma/5.15' 2019-02-07 02:11:14 +02:00
helpers Merge branch 'Plasma/5.14' 2018-11-16 13:48:46 +01:00
kcmkwin Merge branch 'Plasma/5.15' 2019-02-12 08:56:17 +01:00
kconf_update [kconf_update] Use scripted dim screen effect 2018-11-26 16:18:46 +02:00
libinput Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
libkwineffects [libkwineffects] Adjust whitespace in AnimationEffect's header 2019-02-01 00:31:01 +02:00
packageplugins SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-14 05:39:00 +01:00
platformsupport Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
plugins [platforms/drm] Use more ScopedDrmPointer 2019-02-10 20:26:02 +02:00
qml fix virtual keyboard on Plasma Mobile 2018-12-10 16:50:06 +01:00
scripting Fix reorder warning in AbstractScript 2019-01-27 13:25:40 +01:00
scripts SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-16 09:09:19 +01:00
tabbox Silence warnings in TabBoxHandler 2019-01-27 13:25:24 +01:00
tests Use locked cursor position hint 2018-07-27 17:19:33 +02:00
.arcconfig
.arclint Add .arclint 2018-10-02 19:44:07 +03:00
abstract_client.cpp Fix DesktopGrid drag on X11 2019-01-17 23:43:11 +00:00
abstract_client.h Fix DesktopGrid drag on X11 2019-01-17 23:43:11 +00:00
abstract_opengl_context_attribute_builder.cpp Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
abstract_opengl_context_attribute_builder.h Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
abstract_output.cpp Add output orientation size helper 2018-11-14 20:05:39 +01:00
abstract_output.h Add output orientation size helper 2018-11-14 20:05:39 +01:00
activation.cpp Drop no longer needed cast to Client in TabGroup related code 2018-05-20 20:18:09 +02:00
activities.cpp
activities.h
appmenu.cpp Don't try to open application menu when client doesn't have one 2018-04-23 15:42:02 +02:00
appmenu.h Fix minor EBN issues 2018-08-29 21:02:16 +03:00
atoms.cpp Restore global menu support 2017-01-11 10:21:03 +01:00
atoms.h Restore global menu support 2017-01-11 10:21:03 +01:00
client.cpp Merge branch 'Plasma/5.12' into Plasma/5.15 2019-02-05 13:57:09 +02:00
client.h Merge branch 'Plasma/5.12' into Plasma/5.15 2019-02-05 13:57:09 +02:00
client_machine.cpp
client_machine.h
CMakeLists.txt Merge branch 'Plasma/5.15' 2019-02-12 08:56:17 +01:00
composite.cpp Call frameRendered for undamaged Wayland surfaces 2019-01-29 12:38:42 -08:00
composite.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
config-kwin.h.cmake Require libinput and udev 2018-02-04 15:00:42 +01:00
COPYING
cursor.cpp Drop XFixes include in cursor.cpp 2019-01-09 22:29:45 +02:00
cursor.h Move ExtendedCursor::Shape's doc comment to the correct place 2019-02-04 13:59:57 +02:00
dbusinterface.cpp Fix VirtualDesktopManager::createVirtualDesktop 2019-01-21 20:07:55 +02:00
dbusinterface.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
debug_console.cpp i18n: Fix untranslatable table row "Delta" 2018-09-17 13:43:05 +03:00
debug_console.h Require libinput and udev 2018-02-04 15:00:42 +01:00
debug_console.ui fixuifiles 2018-09-18 07:52:44 +02:00
deleted.cpp Move groupTransient and group from Client to AbstractClient as virtual 2019-01-12 07:35:18 +01:00
deleted.h Make whitespace in Deleted consistent 2019-02-06 19:16:18 +02:00
effectloader.cpp
effectloader.h Fix minor EBN issues in the Doxygen code 2018-12-03 23:40:12 +02:00
effects.cpp Switch ThumbnailItem to internal uuid instead of WId 2019-01-27 09:52:15 +01:00
effects.h Switch ThumbnailItem to internal uuid instead of WId 2019-01-27 09:52:15 +01:00
egl_context_attribute_builder.cpp Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
egl_context_attribute_builder.h [qpa] Use the new OpenGLContextAttributeBuilder to create Qt's OpenGL context 2017-07-17 16:53:37 +02:00
events.cpp Create a dedicated X11Filter for Client sync events and move it to X11 platform 2017-10-19 19:56:58 +02:00
fixqopengl.h Fix the build on armhf/aarch64 2018-03-06 09:25:33 +05:30
focuschain.cpp Use explicit Chain type in the focus chain 2018-07-30 11:23:43 +03:00
focuschain.h Use explicit Chain type in the focus chain 2018-07-30 11:23:43 +03:00
geometry.cpp Fix minor EBN issues 2018-08-29 21:02:16 +03:00
geometrytip.cpp
geometrytip.h
gestures.cpp Fix build with clang and GCC6 2017-03-29 14:45:44 +02:00
gestures.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
globalshortcuts.cpp Don't try to filter null key combinations 2018-04-24 16:35:23 +02:00
globalshortcuts.h Fix minor EBN issues in the Doxygen code 2018-12-03 23:40:12 +02:00
group.cpp Move groupTransient and group from Client to AbstractClient as virtual 2019-01-12 07:35:18 +01:00
group.h
HACKING.md Introduce a new HACKING.md document to replace the previous HACKING 2018-12-17 18:11:59 +01:00
idle_inhibition.cpp Use appropriate sequence algorithms in IdleInhibition 2019-01-11 15:28:28 +02:00
idle_inhibition.h Use appropriate sequence algorithms in IdleInhibition 2019-01-11 15:28:28 +02:00
input.cpp Revert "Remove comparison between signed and unsigned integer expressions warning" 2019-01-04 20:30:24 +01:00
input.h Fix minor Doxygen issues 2019-01-11 15:36:22 +02:00
input_event.cpp Pass SwitchEvent from LibInput through KWin and add to DebugConsole 2018-01-09 19:32:58 +01:00
input_event.h Pass SwitchEvent from LibInput through KWin and add to DebugConsole 2018-01-09 19:32:58 +01:00
input_event_spy.cpp Pass SwitchEvent from LibInput through KWin and add to DebugConsole 2018-01-09 19:32:58 +01:00
input_event_spy.h Pass SwitchEvent from LibInput through KWin and add to DebugConsole 2018-01-09 19:32:58 +01:00
keyboard_input.cpp Introduce a command line option to disable any kind of global shortcuts 2018-12-13 19:36:28 +01:00
keyboard_input.h Split KWin::Xkb into a dedicated .h and .cpp 2017-02-15 17:48:55 +01:00
keyboard_layout.cpp Fix warning 2018-04-06 18:43:12 +02:00
keyboard_layout.h Introduce support for keyboard layout switching policies 2017-04-22 08:15:25 +02:00
keyboard_layout_switching.cpp Use end() instead of constEnd() for where we compare to an iterator 2017-04-22 20:28:12 +02:00
keyboard_layout_switching.h Add support for keyboard layout switching policy "winclass" 2017-04-22 08:15:59 +02:00
keyboard_repeat.cpp Split Keyboard Repeat handling into a dedicated InputEventSpy 2017-01-27 16:03:37 +01:00
keyboard_repeat.h Split Keyboard Repeat handling into a dedicated InputEventSpy 2017-01-27 16:03:37 +01:00
killwindow.cpp Use OnScreenNotification in kill window 2016-12-21 19:45:02 +01:00
killwindow.h Support interactive window selection through the Platform 2016-11-17 08:08:56 +01:00
kwin.kcfg Drop OpenGL based color correction from KWin 2016-11-22 07:16:51 +01:00
kwin.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-16 09:09:19 +01:00
kwinbindings.cpp Expose more default window management shortcuts 2018-03-16 17:18:55 -06:00
KWinDBusInterfaceConfig.cmake.in
layers.cpp Move groupTransient and group from Client to AbstractClient as virtual 2019-01-12 07:35:18 +01:00
logind.cpp remove superfluous code 2019-01-27 12:05:22 +05:30
logind.h logind: Add a function that detects the logind seat. 2018-01-05 22:46:39 +01:00
main.cpp Update about data 2018-12-03 10:31:50 +02:00
main.h Ensure the Compositor does not start during termination 2019-01-12 07:36:55 +01:00
main_wayland.cpp Fix --no-global-shortcuts option 2019-02-05 14:32:14 +02:00
main_wayland.h Ensure Workspace is only started once in Wayland-only mode 2017-10-01 09:06:51 +02:00
main_x11.cpp Ensure the Compositor does not start during termination 2019-01-12 07:36:55 +01:00
main_x11.h
Mainpage.dox
manage.cpp Re-evaluate the window rules when the window class of a Client changes 2018-11-07 09:33:39 +01:00
Messages.sh Fix untranslatable strings in debug_console.ui shortcutdialog.ui 2018-09-17 11:39:47 +02:00
modifier_only_shortcuts.cpp Track the actual pressed keys in ModifierOnlyShortcuts 2017-02-23 16:55:41 +01:00
modifier_only_shortcuts.h Track the actual pressed keys in ModifierOnlyShortcuts 2017-02-23 16:55:41 +01:00
moving_client_x11_filter.cpp Move X11 movingClient handling into a dedicated X11EventFilter 2017-09-01 16:57:43 +02:00
moving_client_x11_filter.h Move X11 movingClient handling into a dedicated X11EventFilter 2017-09-01 16:57:43 +02:00
netinfo.cpp Revert "Revert "Add "SkipSwitcher" to API"" 2018-05-23 23:33:39 -05:00
netinfo.h Create a dedicated X11EventFilter for the events used by RootInfo 2017-09-30 12:57:21 +02:00
onscreennotification.cpp Drop invalid .moc file inclusion 2018-03-04 16:10:18 +01:00
onscreennotification.h Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
options.cpp Try all supported Compositor Types of the current Platform 2017-10-19 18:26:33 +02:00
options.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
org.freedesktop.ScreenSaver.xml
org.kde.kappmenu.xml Restore global menu support 2017-01-11 10:21:03 +01:00
org.kde.kwin.ColorCorrect.xml [colorcorrection] Night Color - blue light filter at nighttime 2017-12-11 10:58:40 +01:00
org.kde.kwin.Compositing.xml
org.kde.kwin.Effects.xml
org.kde.kwin.OrientationSensor.xml Add DBus interface to OrientationSensor and a persistent configuration 2017-12-26 22:02:47 +01:00
org.kde.KWin.VirtualDesktopManager.xml [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
org.kde.KWin.xml Add a dbus method getWindowInfo returning same data as queryWindowInfo 2018-12-17 18:12:17 +01:00
orientation_sensor.cpp Add DBus interface to OrientationSensor and a persistent configuration 2017-12-26 22:02:47 +01:00
orientation_sensor.h Add DBus interface to OrientationSensor and a persistent configuration 2017-12-26 22:02:47 +01:00
osd.cpp Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
osd.h Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
outline.cpp Move NonComposited Outline into the X11 standalone platform 2017-09-01 17:07:23 +02:00
outline.h Fix minor Doxygen issues 2019-01-11 15:36:22 +02:00
outputscreens.cpp Move output refresh rate getter into AbstractOutput 2018-11-14 20:04:29 +01:00
outputscreens.h Move output refresh rate getter into AbstractOutput 2018-11-14 20:04:29 +01:00
overlaywindow.cpp Move the X11 specific OverlayWindow into the platform/x11 2017-08-12 11:32:29 +02:00
overlaywindow.h Move the X11 specific OverlayWindow into the platform/x11 2017-08-12 11:32:29 +02:00
placement.cpp Honor struts when placing Wayland transients 2018-12-31 07:58:50 +01:00
placement.h
platform.cpp Remove unused check 2018-10-25 08:05:13 +02:00
platform.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
pointer_input.cpp [wayland] Don't use hardcoded move-resize cursor 2018-12-31 12:35:01 +02:00
pointer_input.h Rework InputDeviceHandler focus tracking 2018-12-02 21:36:11 +01:00
popup_input_filter.cpp Cancel popup if the user clicked window decoration of parent window 2017-04-11 20:22:32 +02:00
popup_input_filter.h Initial support for popup window handling 2017-04-07 16:14:50 +02:00
README.md Add a new markdown README 2018-12-22 08:42:38 +01:00
rootinfo_filter.cpp Create a dedicated X11EventFilter for the events used by RootInfo 2017-09-30 12:57:21 +02:00
rootinfo_filter.h Create a dedicated X11EventFilter for the events used by RootInfo 2017-09-30 12:57:21 +02:00
rules.cpp Port window specific rules dialog to DBus 2018-12-31 07:58:12 +01:00
rules.h Merge branch 'Plasma/5.12' into Plasma/5.13 2018-05-20 15:41:48 +02:00
scene.cpp Use correct flag when checking whether a scene window is opaque 2019-02-10 20:05:45 +02:00
scene.h Drop Phase2Data constructors 2019-01-12 16:31:38 +02:00
screenedge.cpp Fix minor EBN issues 2018-08-29 21:02:16 +03:00
screenedge.h Fix minor Doxygen issues 2019-01-13 09:22:11 +02:00
screenlockerwatcher.cpp
screenlockerwatcher.h
screens.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 2018-06-23 23:26:54 +01:00
screens.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
settings.kcfgc
shadow.cpp Avoid deleting ourselves midway through updateShadow 2018-12-06 12:55:12 +00:00
shadow.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
shell_client.cpp [wayland] Drop Qt extended surface 2019-01-30 01:00:41 +00:00
shell_client.h Drop ShellClient::shellSurface method 2019-02-01 12:54:27 +02:00
shortcutdialog.ui
sm.cpp Merge branch 'Plasma/5.12' into Plasma/5.15 2019-02-05 13:57:09 +02:00
sm.h
tabgroup.cpp Port TabGroup from Client to AbstractClient 2018-05-20 19:50:29 +02:00
tabgroup.h Move TabGroup functionality from Client to AbstractClient 2018-05-20 19:50:35 +02:00
tabletmodemanager.cpp Remove remaining HAVE_INPUT ifdef sections 2018-02-10 20:36:43 +01:00
tabletmodemanager.h Expose if the tablet mode switch is available 2018-01-25 12:46:38 +01:00
TESTING.md [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
thumbnailitem.cpp Switch ThumbnailItem to internal uuid instead of WId 2019-01-27 09:52:15 +01:00
thumbnailitem.h Switch ThumbnailItem to internal uuid instead of WId 2019-01-27 09:52:15 +01:00
toplevel.cpp Copy layer repaints to Deleted 2019-02-10 20:01:40 +02:00
toplevel.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
touch_hide_cursor_spy.cpp Hide mouse cursor when interacting with touch screen 2018-12-13 18:55:46 +01:00
touch_hide_cursor_spy.h Hide mouse cursor when interacting with touch screen 2018-12-13 18:55:46 +01:00
touch_input.cpp Leave decoration on touch up only once 2018-12-13 11:06:08 +01:00
touch_input.h Unset touch targets on no current touch points 2018-12-13 10:59:07 +01:00
udev.cpp [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
udev.h [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
unmanaged.cpp [wayland] Move AbstractClient::desktops from QList to QVector 2018-11-07 16:22:59 +00:00
unmanaged.h [wayland] Move AbstractClient::desktops from QList to QVector 2018-11-07 16:22:59 +00:00
useractions.cpp Port window specific rules dialog to DBus 2018-12-31 07:58:12 +01:00
useractions.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
utils.cpp Make it easier to debug the virtualkeyboard 2018-12-10 16:28:13 +05:30
utils.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
virtual_terminal.cpp
virtual_terminal.h
virtualdesktops.cpp Send done event after the number of rows has been changed 2019-01-25 14:07:07 +02:00
virtualdesktops.h Fix VirtualDesktopManager::createVirtualDesktop 2019-01-21 20:07:55 +02:00
virtualdesktopsdbustypes.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
virtualdesktopsdbustypes.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
virtualkeyboard.cpp Make it easier to debug the virtualkeyboard 2018-12-10 16:28:13 +05:30
virtualkeyboard.h Fix minor EBN issues 2018-08-29 21:02:16 +03:00
virtualkeyboard_dbus.cpp Add DBus protocol to virtual keyboard 2017-10-19 17:59:19 +02:00
virtualkeyboard_dbus.h Add DBus protocol to virtual keyboard 2017-10-19 17:59:19 +02:00
was_user_interaction_x11_filter.cpp Create a dedicated X11EventFilter for recognizing first user interaction 2017-08-19 10:14:53 +02:00
was_user_interaction_x11_filter.h Create a dedicated X11EventFilter for recognizing first user interaction 2017-08-19 10:14:53 +02:00
wayland_cursor_theme.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 2018-06-23 23:26:54 +01:00
wayland_cursor_theme.h Set specific edge cursor shape when resizing 2018-06-11 10:05:07 +01:00
wayland_server.cpp [wayland] Drop Qt extended surface 2019-01-30 01:00:41 +00:00
wayland_server.h [wayland] Drop Qt extended surface 2019-01-30 01:00:41 +00:00
window_property_notify_x11_filter.cpp Clean up includes 2018-08-31 22:58:11 +03:00
window_property_notify_x11_filter.h Add a dedicated X11EventFilter for forwarding property events to the effect system 2017-09-25 20:36:45 +02:00
workspace.cpp Move groupTransient and group from Client to AbstractClient as virtual 2019-01-12 07:35:18 +01:00
workspace.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
x11eventfilter.cpp Support multiple event types in X11EventFilter 2016-11-16 07:48:19 +01:00
x11eventfilter.h Support multiple event types in X11EventFilter 2016-11-16 07:48:19 +01:00
xcbutils.cpp
xcbutils.h Fix minor Doxygen issues 2019-01-12 12:31:32 +02:00
xkb.cpp Support enabling numlock on startup 2018-11-01 17:49:58 +01:00
xkb.h Support enabling numlock on startup 2018-11-01 17:49:58 +01:00
xkb_qt_mapping.h Support mapping QKeyEvent to xkb_keysym_t 2017-09-19 19:09:17 +02:00

KWin

KWin is an easy to use, but flexible, composited Window Manager for Xorg windowing systems (Wayland, X11) on Linux. Its primary usage is in conjunction with a Desktop Shell (e.g. KDE Plasma Desktop). KWin is designed to go out of the way; users should not notice that they use a window manager at all. Nevertheless KWin provides a steep learning curve for advanced features, which are available, if they do not conflict with the primary mission. KWin does not have a dedicated targeted user group, but follows the targeted user group of the Desktop Shell using KWin as it's window manager.

KWin is not...

  • a standalone window manager (c.f. openbox, i3) and does not provide any functionality belonging to a Desktop Shell.
  • a replacement for window managers designed for use with a specific Desktop Shell (e.g. GNOME Shell)
  • a minimalistic window manager
  • designed for use without compositing or for X11 network transparency, though both are possible.

Contacting KWin development team

Support

Application Developer

If you are an application developer having questions regarding windowing systems (either X11 or Wayland) please do not hesitate to contact us. Preferable through our mailing list. Ideally subscribe to the mailing list, so that your mail doesn't get stuck in the moderation queue.

End user

Please contact the support channels of your Linux distribution for user support. The KWin development team does not provide end user support.

Reporting bugs

Please use KDE's bugtracker and report for product KWin.

Developing on KWin

Please refer to hacking documentation for how to build and start KWin. Further information about KWin's test suite can be found in TESTING.md.

Guidelines for new features

A new Feature can only be added to KWin if:

  • it does not violate the primary missions as stated at the start of this document
  • it does not introduce instabilities
  • it is maintained, that is bugs are fixed in a timely manner (second next minor release) if it is not a corner case.
  • it works together with all existing features
  • it supports both single and multi screen (xrandr)
  • it adds a significant advantage
  • it is feature complete, that is supports at least all useful features from competitive implementations
  • it is not a special case for a small user group
  • it does not increase code complexity significantly
  • it does not affect KWin's license (GPLv2+)

All new added features are under probation, that is if any of the non-functional requirements as listed above do not hold true in the next two feature releases, the added feature will be removed again.

The same non functional requirements hold true for any kind of plugins (effects, scripts, etc.). It is suggested to use scripted plugins and distribute them separately.