You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
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
6 years ago
autotests [autotests] Test maximize animation 6 years ago
cmake/modules Follow ECM documentation style 6 years ago
colorcorrection Fix minor Doxygen issues 6 years ago
data Move icons to data dir 6 years ago
decorations support decorations from lookandfeel 6 years ago
doc [KCMs] move GHNS buttons to the normal location 6 years ago
effects Merge branch 'Plasma/5.15' 6 years ago
helpers Merge branch 'Plasma/5.14' 6 years ago
kcmkwin Merge branch 'Plasma/5.15' 6 years ago
kconf_update [kconf_update] Use scripted dim screen effect 6 years ago
libinput Fix minor Doxygen issues 6 years ago
libkwineffects [libkwineffects] Adjust whitespace in AnimationEffect's header 6 years ago
packageplugins SVN_SILENT made messages (.desktop file) - always resolve ours 6 years ago
platformsupport
plugins [platforms/drm] Use more ScopedDrmPointer 6 years ago
qml fix virtual keyboard on Plasma Mobile 6 years ago
scripting Fix reorder warning in AbstractScript 6 years ago
scripts SVN_SILENT made messages (.desktop file) - always resolve ours 6 years ago
tabbox Silence warnings in TabBoxHandler 6 years ago
tests Use locked cursor position hint 6 years ago
.arcconfig
.arclint Add .arclint 6 years ago
CMakeLists.txt Merge branch 'Plasma/5.15' 6 years ago
COPYING
HACKING.md Introduce a new HACKING.md document to replace the previous HACKING 6 years ago
KWinDBusInterfaceConfig.cmake.in
Mainpage.dox
Messages.sh Fix untranslatable strings in debug_console.ui shortcutdialog.ui 6 years ago
README.md Add a new markdown README 6 years ago
TESTING.md [platform/virtual] Drop support for vgem and rendernode 6 years ago
abstract_client.cpp Fix DesktopGrid drag on X11 6 years ago
abstract_client.h Fix DesktopGrid drag on X11 6 years ago
abstract_opengl_context_attribute_builder.cpp
abstract_opengl_context_attribute_builder.h
abstract_output.cpp Add output orientation size helper 6 years ago
abstract_output.h Add output orientation size helper 6 years ago
activation.cpp
activities.cpp
activities.h
appmenu.cpp
appmenu.h Fix minor EBN issues 6 years ago
atoms.cpp
atoms.h
client.cpp Merge branch 'Plasma/5.12' into Plasma/5.15 6 years ago
client.h Merge branch 'Plasma/5.12' into Plasma/5.15 6 years ago
client_machine.cpp
client_machine.h
composite.cpp Call frameRendered for undamaged Wayland surfaces 6 years ago
composite.h Fix minor Doxygen issues 6 years ago
config-kwin.h.cmake
cursor.cpp Drop XFixes include in cursor.cpp 6 years ago
cursor.h Move ExtendedCursor::Shape's doc comment to the correct place 6 years ago
dbusinterface.cpp Fix VirtualDesktopManager::createVirtualDesktop 6 years ago
dbusinterface.h Fix minor Doxygen issues 6 years ago
debug_console.cpp i18n: Fix untranslatable table row "Delta" 6 years ago
debug_console.h
debug_console.ui fixuifiles 6 years ago
deleted.cpp Move groupTransient and group from Client to AbstractClient as virtual 6 years ago
deleted.h Make whitespace in Deleted consistent 6 years ago
effectloader.cpp
effectloader.h Fix minor EBN issues in the Doxygen code 6 years ago
effects.cpp Switch ThumbnailItem to internal uuid instead of WId 6 years ago
effects.h Switch ThumbnailItem to internal uuid instead of WId 6 years ago
egl_context_attribute_builder.cpp
egl_context_attribute_builder.h
events.cpp
fixqopengl.h Fix the build on armhf/aarch64 7 years ago
focuschain.cpp Use explicit Chain type in the focus chain 6 years ago
focuschain.h Use explicit Chain type in the focus chain 6 years ago
geometry.cpp Fix minor EBN issues 6 years ago
geometrytip.cpp
geometrytip.h
gestures.cpp
gestures.h Fix minor Doxygen issues 6 years ago
globalshortcuts.cpp
globalshortcuts.h Fix minor EBN issues in the Doxygen code 6 years ago
group.cpp Move groupTransient and group from Client to AbstractClient as virtual 6 years ago
group.h
idle_inhibition.cpp Use appropriate sequence algorithms in IdleInhibition 6 years ago
idle_inhibition.h Use appropriate sequence algorithms in IdleInhibition 6 years ago
input.cpp Revert "Remove comparison between signed and unsigned integer expressions warning" 6 years ago
input.h Fix minor Doxygen issues 6 years ago
input_event.cpp
input_event.h
input_event_spy.cpp
input_event_spy.h
keyboard_input.cpp Introduce a command line option to disable any kind of global shortcuts 6 years ago
keyboard_input.h
keyboard_layout.cpp
keyboard_layout.h
keyboard_layout_switching.cpp
keyboard_layout_switching.h
keyboard_repeat.cpp
keyboard_repeat.h
killwindow.cpp Use OnScreenNotification in kill window 8 years ago
killwindow.h
kwin.kcfg
kwin.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 6 years ago
kwinbindings.cpp
layers.cpp Move groupTransient and group from Client to AbstractClient as virtual 6 years ago
logind.cpp remove superfluous code 6 years ago
logind.h
main.cpp Update about data 6 years ago
main.h Ensure the Compositor does not start during termination 6 years ago
main_wayland.cpp Fix --no-global-shortcuts option 6 years ago
main_wayland.h
main_x11.cpp Ensure the Compositor does not start during termination 6 years ago
main_x11.h
manage.cpp Re-evaluate the window rules when the window class of a Client changes 6 years ago
modifier_only_shortcuts.cpp
modifier_only_shortcuts.h
moving_client_x11_filter.cpp
moving_client_x11_filter.h
netinfo.cpp
netinfo.h
onscreennotification.cpp
onscreennotification.h
options.cpp
options.h Fix minor Doxygen issues 6 years ago
org.freedesktop.ScreenSaver.xml
org.kde.KWin.VirtualDesktopManager.xml [wayland] Use the new plasma virtual desktop protocol 6 years ago
org.kde.KWin.xml Add a dbus method getWindowInfo returning same data as queryWindowInfo 6 years ago
org.kde.kappmenu.xml
org.kde.kwin.ColorCorrect.xml
org.kde.kwin.Compositing.xml
org.kde.kwin.Effects.xml
org.kde.kwin.OrientationSensor.xml
orientation_sensor.cpp
orientation_sensor.h
osd.cpp
osd.h
outline.cpp
outline.h Fix minor Doxygen issues 6 years ago
outputscreens.cpp Move output refresh rate getter into AbstractOutput 6 years ago
outputscreens.h Move output refresh rate getter into AbstractOutput 6 years ago
overlaywindow.cpp
overlaywindow.h
placement.cpp Honor struts when placing Wayland transients 6 years ago
placement.h
platform.cpp Remove unused check 6 years ago
platform.h Fix minor Doxygen issues 6 years ago
pointer_input.cpp [wayland] Don't use hardcoded move-resize cursor 6 years ago
pointer_input.h Rework InputDeviceHandler focus tracking 6 years ago
popup_input_filter.cpp
popup_input_filter.h
rootinfo_filter.cpp
rootinfo_filter.h
rules.cpp Port window specific rules dialog to DBus 6 years ago
rules.h
scene.cpp Use correct flag when checking whether a scene window is opaque 6 years ago
scene.h Drop Phase2Data constructors 6 years ago
screenedge.cpp Fix minor EBN issues 6 years ago
screenedge.h Fix minor Doxygen issues 6 years ago
screenlockerwatcher.cpp
screenlockerwatcher.h
screens.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 6 years ago
screens.h Fix minor Doxygen issues 6 years ago
settings.kcfgc
shadow.cpp Avoid deleting ourselves midway through updateShadow 6 years ago
shadow.h Fix minor Doxygen issues 6 years ago
shell_client.cpp [wayland] Drop Qt extended surface 6 years ago
shell_client.h Drop ShellClient::shellSurface method 6 years ago
shortcutdialog.ui
sm.cpp Merge branch 'Plasma/5.12' into Plasma/5.15 6 years ago
sm.h
tabgroup.cpp
tabgroup.h
tabletmodemanager.cpp
tabletmodemanager.h
thumbnailitem.cpp Switch ThumbnailItem to internal uuid instead of WId 6 years ago
thumbnailitem.h Switch ThumbnailItem to internal uuid instead of WId 6 years ago
toplevel.cpp Copy layer repaints to Deleted 6 years ago
toplevel.h Fix minor Doxygen issues 6 years ago
touch_hide_cursor_spy.cpp Hide mouse cursor when interacting with touch screen 6 years ago
touch_hide_cursor_spy.h Hide mouse cursor when interacting with touch screen 6 years ago
touch_input.cpp Leave decoration on touch up only once 6 years ago
touch_input.h Unset touch targets on no current touch points 6 years ago
udev.cpp [platform/virtual] Drop support for vgem and rendernode 6 years ago
udev.h [platform/virtual] Drop support for vgem and rendernode 6 years ago
unmanaged.cpp [wayland] Move AbstractClient::desktops from QList to QVector 6 years ago
unmanaged.h [wayland] Move AbstractClient::desktops from QList to QVector 6 years ago
useractions.cpp Port window specific rules dialog to DBus 6 years ago
useractions.h [wayland] Use the new plasma virtual desktop protocol 6 years ago
utils.cpp Make it easier to debug the virtualkeyboard 6 years ago
utils.h Fix minor Doxygen issues 6 years ago
virtual_terminal.cpp Fix build with future glibc (major/minor macros) 9 years ago
virtual_terminal.h
virtualdesktops.cpp Send done event after the number of rows has been changed 6 years ago
virtualdesktops.h Fix VirtualDesktopManager::createVirtualDesktop 6 years ago
virtualdesktopsdbustypes.cpp [wayland] Use the new plasma virtual desktop protocol 6 years ago
virtualdesktopsdbustypes.h [wayland] Use the new plasma virtual desktop protocol 6 years ago
virtualkeyboard.cpp Make it easier to debug the virtualkeyboard 6 years ago
virtualkeyboard.h Fix minor EBN issues 6 years ago
virtualkeyboard_dbus.cpp
virtualkeyboard_dbus.h
was_user_interaction_x11_filter.cpp
was_user_interaction_x11_filter.h
wayland_cursor_theme.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 6 years ago
wayland_cursor_theme.h
wayland_server.cpp [wayland] Drop Qt extended surface 6 years ago
wayland_server.h [wayland] Drop Qt extended surface 6 years ago
window_property_notify_x11_filter.cpp Clean up includes 6 years ago
window_property_notify_x11_filter.h
workspace.cpp Move groupTransient and group from Client to AbstractClient as virtual 6 years ago
workspace.h [wayland] Use the new plasma virtual desktop protocol 6 years ago
x11eventfilter.cpp
x11eventfilter.h
xcbutils.cpp
xcbutils.h Fix minor Doxygen issues 6 years ago
xkb.cpp Support enabling numlock on startup 6 years ago
xkb.h Support enabling numlock on startup 6 years ago
xkb_qt_mapping.h

README.md

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.