My KWIN fork where I work on features like per-output virtual desktops
Find a file
David Edmundson 7e8facc3fd [wayland] Use the new plasma virtual desktop protocol
Summary:
implement virtual desktop support for Wayland.
use the new virtual desktop protocol from D12820
The VirtualDesktopManager class needed some big change in order
to accomodate it, which is where most changes are.
Other than that, it's mostly connections to wire up
VirtualDesktopsManager and VirtualDesktopsManagement(the wayland protocol impl)

Depends on D12820
Other notable detail, is the client visibility updated to reflect the presence
of the client in the plasmavirtualdesktop.
(and the unSetDesktop concept)

Test Plan: used a bit a plasma session together with D12820, D13748 and D13746

Reviewers: #plasma, #kwin, graesslin, davidedmundson

Reviewed By: #plasma, #kwin, davidedmundson

Subscribers: hein, zzag, davidedmundson, kwin

Tags: #kwin

Maniphest Tasks: T4457

Differential Revision: https://phabricator.kde.org/D13887
2018-11-01 16:35:29 +01:00
autotests [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
cmake/modules Revert "Search in default path before calling pkg-config" 2018-09-06 09:34:26 +02:00
colorcorrection [colorcorrection] Make GammaRamp non-copyable 2018-10-07 20:57:57 +03:00
data Remove Qt module declarations in includes 2018-06-05 18:07:23 +01:00
decorations [wayland] Use pending maximize mode in decoration updates 2018-10-07 17:52:34 +01:00
doc [KCMs] move GHNS buttons to the normal location 2018-10-31 07:29:22 -06:00
effects [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
helpers Use qEnvironmentVariableIntValue 2018-10-10 21:47:36 +02:00
kcmkwin SVN_SILENT made messages (.desktop file) - always resolve ours 2018-11-01 08:00:26 +01:00
kconf_update [effects/scale] Port to JavaScript 2018-10-29 10:17:21 +02:00
libinput libinput/connection: Don't hardcode seat0 anymore 2018-04-22 17:29:32 +02:00
libkwineffects [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
packageplugins SVN_SILENT made messages (.desktop file) - always resolve ours 2018-11-01 05:58:11 +01:00
platformsupport Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
plugins SVN_SILENT made messages (.desktop file) - always resolve ours 2018-10-27 05:56:01 +02:00
qml Use consistent size icon in OSD 2018-10-26 12:13:50 +01:00
scripting [scripting] Allow effects to grab windows 2018-10-29 10:17:21 +02:00
scripts SVN_SILENT made messages (.desktop file) - always resolve ours 2018-10-31 08:05:22 +01:00
shaders [libkwinglutils] Cleanup Shader API: removal of ShaderType 2016-01-26 09:42:49 +01:00
tabbox Remove unused captures from lambdas 2018-10-31 09:40:43 +01:00
tests Use locked cursor position hint 2018-07-27 17:19:33 +02:00
.arcconfig Adding .arcconfig 2016-03-15 13:37:47 +01:00
.arclint Add .arclint 2018-10-02 19:44:07 +03:00
16-apps-kwin.png
32-apps-kwin.png
48-apps-kwin.png
abstract_client.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
abstract_client.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01: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 Introduce generic Output class 2018-08-31 11:53:12 +02:00
abstract_output.h [colorcorrection] Set gamma through Output class 2018-08-31 11:58:21 +02:00
activation.cpp Drop no longer needed cast to Client in TabGroup related code 2018-05-20 20:18:09 +02:00
activities.cpp Revert "Remove saving and loading (and client matching by) WM_COMMAND." 2016-06-23 21:07:03 +02:00
activities.h [autotests/integration] Add a first test case for activities 2016-08-12 12:52:47 +02:00
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 Define ShellClient debug output 2018-09-17 04:11:03 +02:00
client.h Define ShellClient debug output 2018-09-17 04:11:03 +02:00
client_machine.cpp
client_machine.h
CMakeLists.txt [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
COMPLIANCE
composite.cpp Don't detach list of damaged windows when sending 'done' events 2018-07-02 12:48:22 +03:00
composite.h Drop the explicit fallback to XRender 2017-10-19 18:26:57 +02:00
config-kwin.h.cmake Require libinput and udev 2018-02-04 15:00:42 +01:00
CONFIGURING
COPYING
COPYING.DOC
cursor.cpp Set specific edge cursor shape when resizing 2018-06-11 10:05:07 +01:00
cursor.h Set specific edge cursor shape when resizing 2018-06-11 10:05:07 +01:00
dbusinterface.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
dbusinterface.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01: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 [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
deleted.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
effectloader.cpp Introduce an EffectsHandler::animationsSupported -> bool 2016-08-15 17:38:33 +02:00
effectloader.h Ensure that EffectsHandlerImpl::slotClientShown is only invoked once per Window 2016-08-03 16:16:00 +02:00
effects.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
effects.h [libkwineffects] Expose getting/setting activeFullScript to scripted effects 2018-10-04 00:57:44 +03: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
ExtraDesktop.sh
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 Port to CMake AUTOMOC 2016-02-01 21:05:36 +01:00
geometrytip.h
gestures.cpp Fix build with clang and GCC6 2017-03-29 14:45:44 +02:00
gestures.h Add support for screenedge touchscreen events through XInput 2.2 2017-03-27 17:44:15 +02:00
globalshortcuts.cpp Don't try to filter null key combinations 2018-04-24 16:35:23 +02:00
globalshortcuts.h Drop unused private field GlobalShortcut::m_axis 2017-08-19 14:19:02 +02:00
group.cpp From 22% of cpu in hasTransientInternal to 0.2x% 2018-01-22 20:15:01 +01:00
group.h
HACKING
idle_inhibition.cpp Fix possible heap-use-after-free in idle inhibition handling 2017-12-03 18:01:43 +01:00
idle_inhibition.h Fix possible heap-use-after-free in idle inhibition handling 2017-12-03 18:01:43 +01:00
input.cpp Disable modifier window actions if global shortcuts are disabled 2018-10-14 09:45:57 +02:00
input.h Remove breaking pointer constraints functionality 2018-09-12 22:55:26 +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 Dependency inject KWayland::Server::SeatInterface into Xkb 2017-08-16 19:22:53 +02: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 2018-09-08 08:44:29 +02:00
kwinbindings.cpp Expose more default window management shortcuts 2018-03-16 17:18:55 -06:00
KWinDBusInterfaceConfig.cmake.in Add path to kwin_wayland binary to KWin's installed CMakeConfig 2015-11-19 09:28:16 +01:00
lanczosfilter.cpp Raise minimum required Mesa version to 10.0 2017-07-06 20:45:58 +02:00
lanczosfilter.h Move SceneOpenGL into a dedicated plugin 2017-09-30 13:12:10 +02:00
layers.cpp Keep Deleted transients above old parents 2018-10-16 18:58:17 +03:00
logind.cpp logind: Add a function that detects the logind seat. 2018-01-05 22:46:39 +01:00
logind.h logind: Add a function that detects the logind seat. 2018-01-05 22:46:39 +01:00
main.cpp Remove Qt module declarations in includes 2018-06-05 18:07:23 +01:00
main.h Drop OperationModeX11AndWayland and introduce OperationModeWaylandOnly instead 2017-09-30 15:09:06 +02:00
main_wayland.cpp Remove duplicated auto backend resolution 2018-09-13 10:20:58 +01: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 Load QtQuick settings 2017-11-01 15:51:21 +00:00
main_x11.h Move everything KCrash related from Application to ApplicationX11 2016-05-09 08:08:49 +02:00
Mainpage.dox
manage.cpp Revert "Revert "Add "SkipSwitcher" to API"" 2018-05-23 23:33:39 -05: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 Move XRandR event filter into XRandRScreens 2017-09-12 18:53:08 +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 [kcmkwin/compositing] Hide config options which don't make sense if Compositing is required 2016-09-13 15:47:42 +02:00
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 method to dbus interface to query information about a window 2018-02-25 14:12:04 +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 Move NonComposited Outline into the X11 standalone platform 2017-09-01 17:07:23 +02:00
outputscreens.cpp Introduce OutputScreens class 2018-08-31 11:53:23 +02:00
outputscreens.h Introduce OutputScreens class 2018-08-31 11:53:23 +02: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 [wayland] Set better placement for XDG Toplevels 2018-10-23 12:37:10 +01:00
placement.h
platform.cpp Remove unused check 2018-10-25 08:05:13 +02:00
platform.h [colorcorrection] Set gamma through Output class 2018-08-31 11:58:21 +02:00
pointer_input.cpp Remove breaking pointer constraints functionality 2018-09-12 22:55:26 +02:00
pointer_input.h Remove breaking pointer constraints functionality 2018-09-12 22:55:26 +02: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
resources.qrc [libkwinglutils] Cleanup Shader API: removal of ShaderType 2016-01-26 09:42:49 +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 Flush kwinrulesrc in RuleBook::save 2018-11-01 11:42:48 +02:00
rules.h Merge branch 'Plasma/5.12' into Plasma/5.13 2018-05-20 15:41:48 +02:00
sc-apps-kwin.svgz
scene.cpp Use qDeleteAll in destructor of Scene class 2018-07-01 18:06:02 +03:00
scene.h Render GL Window decorations at the correct scale 2017-11-01 17:59:11 +00:00
screenedge.cpp Fix minor EBN issues 2018-08-29 21:02:16 +03:00
screenedge.h Move X11 specific event filtering for ScreenEdges into x11 standalone platform 2017-09-01 17:01:01 +02:00
screenlockerwatcher.cpp Delay query whether screenlocker is registered till WaylandServer is initialized 2016-08-16 10:17:14 +02:00
screenlockerwatcher.h [autotests/integration] Add ScreenLockerWatcher to the Test::lockScreen and ::unlockScreen 2016-08-16 10:23:37 +02:00
screens.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 2018-06-23 23:26:54 +01:00
screens.h Load Kwin's internal cursors for the highest resolution of attached monitors 2018-06-23 23:26:54 +01:00
settings.kcfgc
shadow.cpp [shadow] Rebuild quads after creation of shadow 2018-09-13 16:20:04 +03:00
shadow.h Fix typo 2018-08-04 22:35:40 +03:00
shell_client.cpp [wayland] XdgPopup Positioning 2018-10-20 17:17:59 +01:00
shell_client.h [wayland] XdgPopup Positioning 2018-10-20 17:17:59 +01:00
shortcutdialog.ui
sm.cpp Avoid potential assert in SM saving 2018-06-27 01:36:02 +01:00
sm.h Revert "Remove saving and loading (and client matching by) WM_COMMAND." 2016-06-23 21:07:03 +02:00
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
thumbnailitem.cpp Fix minor EBN issues 2018-08-29 21:02:16 +03:00
thumbnailitem.h
toplevel.cpp Render GL Window decorations at the correct scale 2017-11-01 17:59:11 +00:00
toplevel.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
touch_input.cpp Add workaround for touch input offset for decorated windows 2017-01-25 13:58:28 +01:00
touch_input.h Pass LibInput::Device* through the event handlers 2016-05-30 15:26:37 +02:00
udev.cpp udev: Only handle devices from the current seat 2018-04-05 19:47:36 +02:00
udev.h udev: Add the ability to query the current framebuffer. 2018-04-05 19:46:20 +02:00
unmanaged.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
unmanaged.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
useractions.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
useractions.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
utils.cpp Drop unused functions from utils 2017-09-23 21:15:00 +02:00
utils.h Small code style improvement 2018-06-14 15:48:52 +02:00
virtual_terminal.cpp Fix build with future glibc (major/minor macros) 2016-04-20 19:03:34 +02:00
virtual_terminal.h
virtualdesktops.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
virtualdesktops.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01: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 Add DBus protocol to virtual keyboard 2017-10-19 17:59:19 +02:00
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] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
wayland_server.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01: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 [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +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 EBN issues 2018-08-29 21:02:16 +03:00
xkb.cpp Pass the appropriate enumerator to xkb_context_new 2018-10-10 21:36:26 +03:00
xkb.h Support mapping QKeyEvent to xkb_keysym_t 2017-09-19 19:09:17 +02:00
xkb_qt_mapping.h Support mapping QKeyEvent to xkb_keysym_t 2017-09-19 19:09:17 +02:00

- A collection of various documents and links related to KWin is at http://techbase.kde.org/Projects/KWin .


- The mailing list for KWin is kwin@kde.org (https://mail.kde.org/mailman/listinfo/kwin).

- If you want to develop KWin, see file HACKING.

- If you want to check KWin's compliance with specifications, see file COMPLIANCE.

- File CONFIGURATION includes some details on configuring KWin.

- Below is some info for application developers about application interaction
  with the window manager, but it'd need some cleanup.








 This README is meant as an explanation of various window manager related
mechanisms that application developers need to be aware of. As some of these
concepts may be difficult to understand for people not having the required
background knowledge (since sometimes it's difficult even for people who
do have the knowledge), the mechanisms are first briefly explained, and
then an example of fixing the various problems is given.

 For comments, questions, suggestions and whatever use the kwin@kde.org
mailing list.


Table of contents:
==================

- Window relations
    - how to make the window manager know which windows belong together
- Focus stealing prevention
    - how to solve cases where focus stealing prevention doesn't work
      properly automatically



Window relations:
=================

(For now, this explanation of window relations is mainly meant for
focus stealing prevention. To be extended later.)

 All windows created by an application should be organized in a tree
with the root being the application's main window. Note that this is about
toplevel windows, not widgets inside the windows. For example, if you
have KWrite running, with a torn-off toolbar (i.e. a standalone toolbar),
a file save dialog open, and the file save dialog showing a dialog
for creating a directory, the window hiearchy should look like this:


             KWrite mainwindow
              /             \
             /               \
      file save dialog      torn-off toolbar
            \
             \
          create directory dialog

 Each subwindow (i.e. all except for the KWrite mainwindow) points to its
main window (which in turn may have another main window, as in the case
of the file save dialog). When the window manager knows these relations,
it can better arrange the windows (keeping subwindows above their
main windows, preventing activation of a main window of a modal dialog,
and similar). Failing to provide this information to the window manager
may have various results, for example having dialogs positioned below
the main window,

The window property used by subwindows to point to their mainwindows is
called WM_TRANSIENT_FOR. It can be seen by running
'xprop | grep WM_TRANSIENT_FOR' and clicking on a window. If the property
is not present, the window does not (claim to) have any mainwindow.
If the property is present, it's value is the window id of its main window;
window id of any window can be found out by running 'xwininfo'. A window
having WM_TRANSIENT_FOR poiting to another window is said to be transient
for that window.

 In some cases, the WM_TRANSIENT_FOR property may not point to any other
existing window, having value of 0, or pointing to the screen number
('xwininfo -root'). These special values mean that the window is transient
for all other windows in its window group. This should be used only
in rare cases, everytime a specific main window is known, WM_TRANSIENT_FOR
should be pointing to it instead of using one of these special values.
(The explanation why is beyond the scope of this document - just accept it
as a fact.)

 With Qt, the WM_TRANSIENT_FOR property is set by Qt automatically, based
on the toplevel widget's parent. If the toplevel widget is of a normal
type (i.e. not a dialog, toolbar, etc.), Qt doesn't set WM_TRANSIENT_FOR
on it. For special widgets, such as dialogs, WM_TRANSIENT_FOR is set
to point to the widget's parent, if it has a specific parent, otherwise
WM_TRANSIENT_FOR points to the root window.

 As already said above, WM_TRANSIENT_FOR poiting to the root window should
be usually avoided, so everytime the widget's main widget is known, the widget
should get it passed as a parent in its constructor.
(TODO KDialog etc. classes should not have a default argument for the parent
argument, and comments like 'just pass 0 as the parent' should go.)



Focus stealing prevention:
==========================

 Since KDE3.2 KWin has a feature called focus stealing prevention. As the name
suggests, it prevents unexpected changes of focus. With older versions of KWin,
if any application opened a new dialog, it became active, and
if the application's main window was on another virtual desktop, also
the virtual desktop was changed. This was annoying, and also sometimes led
to dialogs mistakenly being closed because they received keyboard input that
was meant for the previously active window.

 The basic principle of focus stealing prevention is that the window with most
recent user activity wins. Any window of an application will become active
when being shown only if this application was the most recently used one.
KWin itself, and some of the related kdecore classes should take care
of the common cases, so usually there's no need for any special handling
in applications. Qt/KDE applications, that is. Applications using other
toolkits should in most cases work fine too. If they don't support
the window property _NET_WM_USER_TIME, the window manager may fail to detect
the user timestamp properly, resulting either in other windows becoming active
while the user works with this application, or this application may sometimes
steal focus (this second case should be very rare though).

 There are also cases where KDE applications needs special handling. The two
most common cases are when windows relations are not setup properly to make
KWin realize that they belong to the same application, and when the user
activity is not represented by manipulating with the application windows
themselves.

 Also note that focus stealing prevention implemented in the window manager
can only help with focus stealing between different applications.
If an application itself suddenly pops up a dialog, KWin cannot do anything about
it, and its the application's job to handle this case.


Window relations:
-----------------

 The common case here is when a dialog is shown for an application, but this
dialog is not provided by the application itself, but by some other process.
For example, dialogs with warnings about accepted cookies are provided
by KCookieJar, instead of being shown by Konqueror. In the normal case,
from KWin's point of view the cookie dialog would be an attempt of another
application to show a dialog, and KWin wouldn't allow activation of this
window.

 The solution is to tell the window manager about the relation between
the Konqueror main window and the cookie dialog, by making the dialog
point to the mainwindow. Note that this is not special to focus stealing
prevention, subwindows such as dialogs, toolbars and similar should always
point to their mainwindow. See the section on window relations for full
description.

 The WM_TRANSIENT_FOR property that's set on dialogs to point to their
mainwindow should in the cookie dialog case point to the Konqueror window
for which it has been shown. This is solved in kcookiejar by including
the window id in the DCOP call. When the cookie dialog is shown, its
WM_TRANSIENT_FOR property is manually set using the XSetTransientForHint()
call (see kdelibs/kioslave/http/kcookiejar/kcookiewin.cpp). The arguments
to XSetTransientForHint() call are the X display (i.e. QX11Info::display()),
the window id on which the WM_TRANSIENT_FOR property is to be set
(i.e. use QWidget::winId()), and the window id of the mainwindow.


  Simple short HOWTO:
  
 To put it simply: Let's say you have a daemon application that has
DCOP call "showDialog( QString text )", and when this is called, it shows
a dialog with the given text. This won't work properly with focus stealing
prevention. The DCOP call should be changed to
"showDialog( QString text, long id )". The caller should pass something like
myMainWindow->winId() as the second argument. In the daemon, before
the dialog is shown, a call to XSetTransientHint() should be added:

 XSetTransientForHint( QX11Info::display(), dialog->winId(), id_of_mainwindow );
 
 That's it.

Non-standard user activity:
---------------------------

 The most common case in KDE will be DCOP calls. For example, KDesktop's DCOP
call "KDesktopIface popupExecuteCommand". Executing this DCOP call e.g.
from Konsole as 'dcop kdesktop KDesktopIface popupExecuteCommand" will lead
to showing the minicli, but the last user activity timestamp gained from events
sent by X server will be older than user activity timestamp of Konsole, and
would normally result in minicli not being active. Therefore, before showing
the minicli, kdesktop needs to call KApplication::updateUserTimestamp().

 However, this shouldn't be done with all DCOP calls. If a DCOP call is not
a result of direct user action, calling KApplication::updateUserTimestamp()
would lead to focus stealing. For example, let's assume for a moment
that KMail would use this DCOP call in case it detects the modem is not
connected, allowing to you to start KPPP or whatever tool you use. If KMail
would be configured to check mail every 10 minutes, this would lead to minicli
possibly suddenly showing up at every check. Basically, doing the above change
to kdesktop's minicli means that the popupExecuteCommand() DCOP call is only
for user scripting. (TODO write about focus transferring?)

 Simply said, KApplication::updateUserTimestamp() should be called only
as a result of user action. Unfortunately, I'm not aware of any universal
way how to handle this, so every case will have to be considered separately.