KWin 5 with ICC color correction effect
 
 
 
 
 
 
Go to file
Andreas Kling 00b1ad8e18 Plug an X11 property leak in Client::getSyncCounter()
svn path=/trunk/KDE/kdebase/workspace/; revision=1022615
2009-09-12 09:42:03 +00:00
clients Minor improvements to tab names/tooltips. 2009-09-10 16:05:14 +00:00
data SVN_SILENT made messages (.desktop file) 2009-08-23 12:06:49 +00:00
effects reove the window from the ignored list of the fade effect if the sliding 2009-09-09 10:05:52 +00:00
kcmkwin Remove flicker when changing effect plugins by not fully reloading compositing plugins anymore. 2009-09-11 21:03:24 +00:00
killer i18n style guide fix 2009-08-22 06:08:08 +00:00
lib Fixed some uses of uninitialized data (SceneOpenGL::selfCheckDone and TimeLine::m_CurveShape) 2009-09-12 09:38:12 +00:00
tools Testapp to show all icons provided by a window. 2009-01-29 15:11:17 +00:00
CMakeLists.txt Implement initial support for ARGB window decorations. 2009-04-22 17:29:56 +00:00
COMPLIANCE This change allows KWin to use the new NETWinInfo2 class (binary 2008-11-17 08:03:39 +00:00
COMPOSITE_HOWTO Normal Xinerama breaks compositing. 2008-01-28 11:11:12 +00:00
COMPOSITE_TODO Remove outdated/duplicated points. Little bit of resorting as well. 2008-09-18 15:43:48 +00:00
CONFIGURING Merging from old trunk: 2007-04-29 21:41:03 +00:00
HACKING Replaced outdated URL. 2008-11-25 15:15:15 +00:00
Mainpage.dox Apidocs mainpage work. Just got Plasma and Solid to do here. 2007-07-24 18:30:36 +00:00
Messages.sh Add file to extract i18n 2007-07-07 22:15:32 +00:00
NEWCOLORSCHEME.README branches/work/kwin_composite becomes new trunk kwin. 2007-04-29 17:35:43 +00:00
README Add a link to the techbase KWin page, which should be where all other docs and links are referenced. 2008-11-05 19:57:33 +00:00
activation.cpp BUG: 167138 2009-07-27 13:30:08 +00:00
atoms.cpp Just create the _MOTIF_WM_INFO atom, without using it at all. 2008-10-03 07:38:31 +00:00
atoms.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
bridge.cpp Remove old decoration shadow API, rename AbilityProvidesShadow and add 2009-06-11 08:11:13 +00:00
bridge.h Remove old decoration shadow API, rename AbilityProvidesShadow and add 2009-06-11 08:11:13 +00:00
client.cpp Plug an X11 property leak in Client::getSyncCounter() 2009-09-12 09:42:03 +00:00
client.h Quick maximize and tiling when moving a window to the left/right or top screen edge. 2009-09-08 20:01:08 +00:00
composite.cpp notify decorations when compositing is suspended 2009-09-10 05:05:44 +00:00
compositingprefs.cpp Detect radeon by using at least "Mesa DRI R", not 2009-06-11 20:58:51 +00:00
compositingprefs.h Force OpenGL compositing to be off if OpenGL rendering is done in software 2008-10-15 13:41:53 +00:00
config-kwin.h.cmake branches/work/kwin_composite becomes new trunk kwin. 2007-04-29 17:35:43 +00:00
deleted.cpp Copy decoration pixmaps to Deleted. By that we see the decoration also when having a fade out animation. 2009-07-29 11:07:28 +00:00
deleted.h Copy decoration pixmaps to Deleted. By that we see the decoration also when having a fade out animation. 2009-07-29 11:07:28 +00:00
desktopchangeosd.cpp Hide desktop change osd after 1000 msec instead of 1500 - it was shown too long. 2009-06-22 20:12:57 +00:00
desktopchangeosd.h New on-screen-display for desktop change. It highlights the new desktop and shows arrows from the old to the new desktop. It replaces the popupinfo which only showed the desktop name. Nevertheless keeping popupinfo in svn so if wanted we can add an option to select between osd and popupinfo. 2009-04-06 16:09:34 +00:00
desktoplayout.cpp Fixed desktopAbove/Below/ToLeft/ToRight() coordinate detection. 2009-02-16 04:12:14 +00:00
effects.cpp Don't const effect proxies. 2009-09-02 02:30:22 +00:00
effects.h Don't const effect proxies. 2009-09-02 02:30:22 +00:00
events.cpp A number of small warning fixes (bracketing, etc) to help pick up real problems when working. 2009-09-11 23:44:29 +00:00
geometry.cpp Adding new option to disable the legacy fullscreen mode (borderless, not netwm compliant windows with screen geometry). 2009-09-08 20:19:20 +00:00
geometrytip.cpp GeometryTip has to use X11BypassWindowManagerHint to see this window in compositing. 2009-05-09 09:06:53 +00:00
geometrytip.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
group.cpp global typo fix 2009-02-07 01:12:28 +00:00
group.h This change allows KWin to use the new NETWinInfo2 class (binary 2008-11-17 08:03:39 +00:00
killwindow.cpp License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
killwindow.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
kwin.kcfg Remove all code for non-composited animations - they don't work anyway. 2007-11-20 16:07:20 +00:00
kwin.notifyrc SVN_SILENT made messages (.desktop file) 2009-08-23 12:06:49 +00:00
kwinbindings.cpp Add keybinding for show desktop. 2009-09-12 08:01:44 +00:00
layers.cpp leak-- 2009-04-09 20:48:44 +00:00
main.cpp A number of small warning fixes (bracketing, etc) to help pick up real problems when working. 2009-09-11 23:44:29 +00:00
main.h SVN_SILENT Standardized coding style on main.* and manage.cpp 2008-12-18 15:01:25 +00:00
manage.cpp BUG: 203903 2009-08-15 17:33:47 +00:00
notifications.cpp Use custom notification for compositing suspended via dbus. 2009-04-06 09:33:43 +00:00
notifications.h Use custom notification for compositing suspended via dbus. 2009-04-06 09:33:43 +00:00
nvidiahack.cpp After recent optimizations __GL_YIELD=NOTHING does not give noticeable 2008-03-20 11:42:58 +00:00
options.cpp A number of small warning fixes (bracketing, etc) to help pick up real problems when working. 2009-09-11 23:44:29 +00:00
options.h Adding new option to disable the legacy fullscreen mode (borderless, not netwm compliant windows with screen geometry). 2009-09-08 20:19:20 +00:00
org.kde.KWin.xml Show current compositing state (disabled/suspended/active) in Desktop Effects KCM and add a button to resume/suspend compositing. So it should be easier for the user to resume compositing if he does not know about the shortcut. 2009-04-18 10:07:16 +00:00
ox16-app-kwin.png Optimize PNG files again. 2008-01-02 00:10:07 +00:00
ox32-app-kwin.png Optimize PNG files again. 2008-01-02 00:10:07 +00:00
ox48-app-kwin.png Optimize PNG files again. 2008-01-02 00:10:07 +00:00
oxsc-app-kwin.svgz remove crystal, remove with mono icons until oxygen icons get made 2007-11-20 16:47:36 +00:00
paintredirector.cpp Implement initial support for ARGB window decorations. 2009-04-22 17:29:56 +00:00
paintredirector.h Implement initial support for ARGB window decorations. 2009-04-22 17:29:56 +00:00
placement.cpp add brace to avoid compiling warning of gcc 2008-12-08 03:49:44 +00:00
placement.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
plugins.cpp Replace Ozone with Nitrogen as the default decoration and remove Ozone. 2009-08-29 10:12:00 +00:00
plugins.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
popupinfo.cpp Set window flag X11BypassWindowManagerHint so that the window is on top of stacking order. By that the popup info is also shown when compositing is enabled. The popup info shown time is increased to 750 ms so that it is visible if fade effect is enabled. 2009-03-04 12:57:33 +00:00
popupinfo.h Mark hide() explicitly as a slot, since it's not virtual with Qt4. 2008-11-11 16:31:24 +00:00
rules.cpp BUG: 167138 2009-07-27 13:30:08 +00:00
rules.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
scene.cpp When we have a shaded window we have to create the four decoration quads manually. For each deco pixmap there has to be one quad of same size. 2009-07-30 18:22:21 +00:00
scene.h Fix shaded and shaped windows not being clipped correctly. 2009-05-27 16:04:58 +00:00
scene_basic.cpp Fix iterator 2008-11-11 23:09:11 +00:00
scene_basic.h License cleanup - add headers where missing, be explicit about GPL 2007-11-27 19:40:25 +00:00
scene_opengl.cpp Fixed some uses of uninitialized data (SceneOpenGL::selfCheckDone and TimeLine::m_CurveShape) 2009-09-12 09:38:12 +00:00
scene_opengl.h OpenGL part of ARGB decorations. See revision 957680 for more information. 2009-04-22 17:30:49 +00:00
scene_xrender.cpp A number of small warning fixes (bracketing, etc) to help pick up real problems when working. 2009-09-11 23:44:29 +00:00
scene_xrender.h Implement initial support for ARGB window decorations. 2009-04-22 17:29:56 +00:00
sm.cpp BUG: 203903 2009-08-15 17:33:47 +00:00
sm.h BUG: 203903 2009-08-15 17:33:47 +00:00
tabbox.cpp make "holding tab down like a mad man" give visual feedback 2009-06-21 12:29:37 +00:00
tabbox.h * if grahpicEffectsLevel() allows it, animate the selection background. 2009-06-19 21:22:45 +00:00
toplevel.cpp Make sure that the repainted area includes the whole area 2009-06-11 20:12:11 +00:00
toplevel.h Reset Repaints on a Toplevel has to include the decoration shadows if used. 2009-08-04 12:20:33 +00:00
unmanaged.cpp This change allows KWin to use the new NETWinInfo2 class (binary 2008-11-17 08:03:39 +00:00
unmanaged.h Support for unredirecting fullscreen windows, i.e. games etc. can paint directly 2008-08-24 13:32:57 +00:00
useractions.cpp Add keybinding for show desktop. 2009-09-12 08:01:44 +00:00
utils.cpp Use CurrentTime instead of xTime() for XUngrabKeyboard 2009-07-26 21:50:35 +00:00
utils.h Improved window movement around struts. Windows can be moved anywhere 2009-02-17 15:50:00 +00:00
workspace.cpp notify decorations when compositing is enabled/disabled 2009-09-10 05:06:53 +00:00
workspace.h Add keybinding for show desktop. 2009-09-12 08:01:44 +00:00

README

- 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.