KWin Class Reference
Convenience access to certain properties and features of the window manager. Class for interaction with the window manager. More...
#include <kwin.h>
Public Types | |
enum | IconSource { NETWM = 1, WMHints = 2, ClassHint = 4, XApp = 8 } |
Static Public Member Functions | |
void | activateWindow (WId win, long time=0) |
void | forceActiveWindow (WId win, long time=0) |
void | setActiveWindow (WId win) KDE_DEPRECATED |
void | demandAttention (WId win, bool set=true) |
void | setUserTime (WId win, long time) |
void | invokeContextHelp () |
void | setSystemTrayWindowFor (WId trayWin, WId forWin) |
WindowInfo | windowInfo (WId win, unsigned long properties=0, unsigned long properties2=0) |
WId | transientFor (WId window) |
WId | groupLeader (WId window) |
QPixmap | icon (WId win, int width=-1, int height=-1, bool scale=false) |
QPixmap | icon (WId win, int width, int height, bool scale, int flags) |
void | setIcons (WId win, const QPixmap &icon, const QPixmap &miniIcon) |
void | setType (WId win, NET::WindowType windowType) |
void | setState (WId win, unsigned long state) |
void | clearState (WId win, unsigned long state) |
void | setOnAllDesktops (WId win, bool b) |
void | setOnDesktop (WId win, int desktop) |
void | setExtendedStrut (WId win, int left_width, int left_start, int left_end, int right_width, int right_start, int right_end, int top_width, int top_start, int top_end, int bottom_width, int bottom_start, int bottom_end) |
void | setStrut (WId win, int left, int right, int top, int bottom) |
int | currentDesktop () |
int | numberOfDesktops () |
void | setCurrentDesktop (int desktop) |
void | iconifyWindow (WId win, bool animation=true) |
void | deIconifyWindow (WId win, bool animation=true) |
void | raiseWindow (WId win) |
void | lowerWindow (WId win) |
bool | icccmCompliantMappingState () |
bool | allowedActionsSupported () |
QString | readNameProperty (WId window, unsigned long atom) |
Info | info (WId win) KDE_DEPRECATED |
void | appStarted () KDE_DEPRECATED |
Detailed Description
Convenience access to certain properties and features of the window manager. Class for interaction with the window manager.This class is not supposed to be instantiated. It exists mostly as a namespace for the static member functions.
In KDE 2 and KDE 3, communication with the windowmanager is done with the NET-protocol, a common window manager specification designed by various authors of X11 window managers (including those of the KDE project). The full specification can be found at www.freedesktop.org/standards/wm-spec .
To access features of the NET-protocol, use the classes NETRootInfo and NETWinInfo.
The purpose of this class is to to provide easy access to the most-commonly used NET-features with a simpler, KDEish interface.
In addition, it encapsulates KDE functionality not yet provided by the NET hints. Currently that is invokeContextHelp() and setSystemTrayWindowFor() only.
- See also:
- NET
NetWinInfo
- Author:
- Matthias Ettrich (ettrich@kde.org)
Definition at line 59 of file kwin.h.
Member Enumeration Documentation
|
Masks specifying from which sources to read an icon. They are tried from the best until an icon is found.
|
Member Function Documentation
|
Requests that window There are two ways how to activate a window, by calling activateWindow() and forceActiveWindow(). Generally, applications shouldn't make attempts to explicitly activate their windows, and instead let the user to activate them. In the special cases where this may be needed, applications should use activateWindow(). Window manager may consider whether this request wouldn't result in focus stealing, which would be obtrusive, and may refuse the request. The usage of forceActiveWindow() is meant only for pagers and similar tools, which represent direct user actions related to window manipulation. Except for rare cases, this request will be always honored, and normal applications are forbidden to use it. In case of problems, consult the KWin README in the kdebase package (kdebase/kwin/README), or ask on the kwin@kde.org mailing list.
References info(), and NETRootInfo::setActiveWindow(). |
|
Sets window Note that this should be called only in special cases, applications shouldn't force themselves or other windows to be the active window. Generally, this call should used only by pagers and similar tools. See the explanation in description of activateWindow().
References info(), and NETRootInfo::setActiveWindow(). Referenced by KStartupInfo::setNewStartupId(). |
|
References info(), and NETRootInfo::setActiveWindow(). |
|
When application finishes some operation and wants to notify the user about it, it can call demandAttention(). Instead of activating the window, which could be obtrusive, the window will be marked specially as demanding user's attention. See also explanation in description of activateWindow(). Note that it's usually better to use KNotifyClient.
References info(), and NETWinInfo::setState(). |
|
Sets user timestamp The timestamp is expressed as XServer time. If a window is shown with user timestamp older than the time of the last user action, it won't be activated after being shown. The most common case is the special value 0 which means not to activate the window after being shown.
References info(), and NETWinInfo::setUserTime(). |
|
Invokes interactive context help. |
|
Makes A system tray window serves as an icon replacement. It's displayed inside the panel's system tray.
References endl(), info(), NETRootInfo::isSupported(), DCOPRef::send(), and NETWinInfo::setKDESystemTrayWinFor(). |
|
Returns information about window It is recommended to check whether the returned info is valid by calling the valid() method.
|
|
Returns the WM_TRANSIENT_FOR property for the given window, i.e. the mainwindow for this window.
|
|
Returns the leader window for the group the given window is in, if any.
|
|
Returns an icon for window
If
If
|
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Overloaded variant that allows specifying from which sources the icon should be read. You should usually prefer the simpler variant which tries all possibilities to get an icon.
References ClassHint, NETIcon::data, NETSize::height, NETWinInfo::icon(), KInstance::iconLoader(), info(), KGlobal::instance(), KIconLoader::loadIcon(), NETWM, NETIcon::size, NETSize::width, WMHints, and XApp. |
|
Sets an
References NETIcon::data, NETSize::height, info(), NETWinInfo::setIcon(), NETIcon::size, and NETSize::width. Referenced by KApplication::setTopWidget(). |
|
Sets the type of window Possible values are NET::Normal, NET::Desktop, NET::Dock, NET::Tool, NET::Menu, NET::Dialog, NET::Override (== no decoration frame), NET::TopMenu, NET::Utility or NET::Splash
References info(), and NETWinInfo::setWindowType(). |
|
Sets the state of window Possible values are or'ed combinations of NET::Modal, NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded, NET::SkipTaskbar, NET::SkipPager, NET::Hidden, NET::FullScreen, NET::KeepAbove, NET::KeepBelow, NET::StaysOnTop
References info(), and NETWinInfo::setState(). |
|
Clears the state of window Possible values are or'ed combinations of NET::Modal, NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded, NET::SkipTaskbar, NET::SkipPager, NET::Hidden, NET::FullScreen, NET::KeepAbove, NET::KeepBelow, NET::StaysOnTop
References info(), and NETWinInfo::setState(). |
|
Sets window Otherwise the window lives only on one single desktop.
References NETRootInfo::currentDesktop(), NETWinInfo::desktop(), info(), and NETWinInfo::setDesktop(). |
|
Moves window
References info(), and NETWinInfo::setDesktop(). |
|
Sets the strut of window For not reserving a strut, pass 0 as the width. E.g. to reserve 10x10 square in the topleft corner, use e.g. setExtendedStrut( w, 10, 0, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0 ).
References NETExtendedStrut::bottom_end, NETExtendedStrut::bottom_start, NETExtendedStrut::bottom_width, info(), NETExtendedStrut::left_end, NETExtendedStrut::left_start, NETExtendedStrut::left_width, NETExtendedStrut::right_end, NETExtendedStrut::right_start, NETExtendedStrut::right_width, NETWinInfo::setExtendedStrut(), NETExtendedStrut::top_end, NETExtendedStrut::top_start, and NETExtendedStrut::top_width. |
|
References NETStrut::bottom, info(), NETStrut::left, NETStrut::right, NETWinInfo::setStrut(), and NETStrut::top. |
|
Convenience function to access the current desktop. See NETRootInfo.
References NETRootInfo::currentDesktop(), and info(). Referenced by KWin::WindowInfo::isOnCurrentDesktop(). |
|
Convenience function to access the number of desktops. See NETRootInfo.
References info(), and NETRootInfo::numberOfDesktops(). |
|
Convenience function to set the current desktop to See NETRootInfo.
References info(), and NETRootInfo::setCurrentDesktop(). |
|
Iconifies a window.
Compatible to XIconifyWindow but has an additional parameter
|
|
DeIconifies a window.
Compatible to XMapWindow but has an additional parameter
|
|
Raises the given window. This call is only for pagers and similar tools that represent direct user actions. Applications should not use it, they should keep using QWidget::raise() or XRaiseWindow() if necessary.
References info(), NETRootInfo::isSupported(), and NETRootInfo::restackRequest(). |
|
Lowers the given window. This call is only for pagers and similar tools that represent direct user actions. Applications should not use it, they should keep using QWidget::lower() or XLowerWindow() if necessary.
References info(), NETRootInfo::isSupported(), and NETRootInfo::restackRequest(). |
|
Returns true if the WM announces which actions it allows for windows.
References info(), and NETRootInfo::isSupported(). Referenced by KWin::WindowInfo::actionSupported(). |
|
Function that reads and returns the contents of the given text property (WM_NAME, WM_ICON_NAME,...).
Referenced by KWin::WindowInfo::WindowInfo(). |
|
|
Definition at line 652 of file kwin.cpp. References KStartupInfo::appStarted(). |
The documentation for this class was generated from the following files: