kdecore Library API Documentation

KWin::WindowInfo Class Reference

Information about a window. More...

#include <kwin.h>

List of all members.

Public Member Functions

 WindowInfo (WId window, unsigned long properties, unsigned long properties2)
bool valid (bool withdrawn_is_valid=false) const
WId win () const
unsigned long state () const
bool hasState (unsigned long s) const
bool isMinimized () const
NET::MappingState mappingState () const
NETExtendedStrut extendedStrut () const
NETStrut strut () const
NET::WindowType windowType (int supported_types) const
QString visibleName () const
QString visibleNameWithState () const
QString name () const
QString visibleIconName () const
QString visibleIconNameWithState () const
QString iconName () const
bool isOnCurrentDesktop () const
bool isOnDesktop (int desktop) const
bool onAllDesktops () const
int desktop () const
QRect geometry () const
QRect frameGeometry () const
WId transientFor () const
WId groupLeader () const
QCString windowClassClass () const
QCString windowClassName () const
QCString windowRole () const
QCString clientMachine () const
bool actionSupported (NET::Action action) const
 WindowInfo (const WindowInfo &)
WindowInfooperator= (const WindowInfo &)


Detailed Description

Information about a window.

Since:
3.2

Definition at line 469 of file kwin.h.


Constructor & Destructor Documentation

KWin::WindowInfo::WindowInfo WId  window,
unsigned long  properties,
unsigned long  properties2
 

Reads all the info about the given window.

Definition at line 684 of file kwin.cpp.

References KXErrorHandler::error(), NETSize::height, NETRect::pos, KWin::readNameProperty(), NETRect::size, NETSize::width, NETPoint::x, and NETPoint::y.


Member Function Documentation

bool KWin::WindowInfo::valid bool  withdrawn_is_valid = false  )  const
 

Returns false if this window info is not valid (most probably the given window doesn't exist).

Parameters:
withdrawn_is_valid if true, windows in the withdrawn state (i.e. not managed) are also considered. This is usually not the case.

Definition at line 770 of file kwin.cpp.

References mappingState().

WId KWin::WindowInfo::win  )  const
 

Returns the window identifier.

Definition at line 779 of file kwin.cpp.

unsigned long KWin::WindowInfo::state  )  const
 

Returns the window's state flags (see the NET::State enum for details).

Requires NET::WMState passed to KWin::windowInfo().

Definition at line 784 of file kwin.cpp.

Referenced by isMinimized().

bool KWin::WindowInfo::hasState unsigned long  s  )  const [inline]
 

Returns true if the window has the given state flag set (see the NET::State enum for details).

Requires NET::WMState passed to KWin::windowInfo().

Since:
3.2.1

Definition at line 499 of file kwin.h.

bool KWin::WindowInfo::isMinimized  )  const
 

Returns true if the window is minimized.

Note that it is true only if the window is truly minimized, not shaded or on another virtual desktops, which makes it different from mappingState() == NET::Iconic or QWidget::isMinimized(). Requires NET::WMState and NET::XAWMState passed to KWin::windowInfo().

Definition at line 1087 of file kwin.cpp.

References mappingState(), and state().

Referenced by visibleIconNameWithState(), and visibleNameWithState().

NET::MappingState KWin::WindowInfo::mappingState  )  const
 

Returns the mapping state of the window (see NET::MappingState).

Note that it's very likely that you don't want to use this function, and use isOnDesktop(), isMinimized() etc. instead. Requires NET::XAWMState passed to KWin::windowInfo().

Definition at line 795 of file kwin.cpp.

Referenced by isMinimized(), and valid().

NETExtendedStrut KWin::WindowInfo::extendedStrut  )  const
 

Returns the window extended (partial) strut.

Requires NET::WM2ExtendedStrut passed to KWin::windowInfo().

Definition at line 806 of file kwin.cpp.

References NETStrut::bottom, NETExtendedStrut::bottom_end, NETExtendedStrut::bottom_start, NETExtendedStrut::bottom_width, NETStrut::left, NETExtendedStrut::left_end, NETExtendedStrut::left_start, NETExtendedStrut::left_width, NETStrut::right, NETExtendedStrut::right_end, NETExtendedStrut::right_start, NETExtendedStrut::right_width, NETStrut::top, NETExtendedStrut::top_end, NETExtendedStrut::top_start, and NETExtendedStrut::top_width.

NETStrut KWin::WindowInfo::strut  )  const
 

Deprecated:
use extendedStrut() Returns the window strut. Requires NET::WMStrut passed to KWin::windowInfo().

Definition at line 844 of file kwin.cpp.

NET::WindowType KWin::WindowInfo::windowType int  supported_types  )  const
 

Returns the window type of this window (see NET::WindowType).

The argument should be all window types your application supports (see NET::WindowTypeMask). Requires NET::WMWindowType passed to KWin::windowInfo().

Definition at line 856 of file kwin.cpp.

QString KWin::WindowInfo::visibleName  )  const
 

Returns the visible name of the window (i.e.

including possible <2> appended when there are two or more windows with the same name). Requires NET::WMVisibleName passed to KWin::windowInfo().

Definition at line 887 of file kwin.cpp.

References name().

Referenced by visibleIconName(), and visibleNameWithState().

QString KWin::WindowInfo::visibleNameWithState  )  const
 

Returns a visible name with state.

This is a simple convenience function that returns the visible name but with parentheses around minimized windows. Requires NET::WMVisibleName, NET::WMState and NET::XAWMState passed to KWin::windowInfo().

Returns:
the window name with state

Definition at line 867 of file kwin.cpp.

References isMinimized(), and visibleName().

QString KWin::WindowInfo::name  )  const
 

Returns the name of the window, as specified by the application, without any modifications.

You should often use visibleName() instead. Requires NET::WMName passed to KWin::windowInfo().

Definition at line 899 of file kwin.cpp.

Referenced by iconName(), and visibleName().

QString KWin::WindowInfo::visibleIconName  )  const
 

Returns the visible name of the window that should be shown in taskbar and all other "iconic" representations of the window.

Note that this has nothing to do with normal icons. Requires NET::WMVisibleIconName passed to KWin::windowInfo().

Definition at line 920 of file kwin.cpp.

References visibleName().

Referenced by visibleIconNameWithState().

QString KWin::WindowInfo::visibleIconNameWithState  )  const
 

Returns a visible name with state.

This is a simple convenience function that returns the visible iconic name but with parentheses around minimized windows. Note that this has nothing to do with normal icons. Requires NET::WMVisibleIconName, NET::WMState and NET::XAWMState passed to KWin::windowInfo().

Returns:
the window iconic name with state

Definition at line 910 of file kwin.cpp.

References isMinimized(), and visibleIconName().

QString KWin::WindowInfo::iconName  )  const
 

Returns the name of the window that should be shown in taskbar and all other "iconic" representations of the window.

Note that this has nothing to do with normal icons. Requires NET::WMIconName passed to KWin::windowInfo().

Definition at line 935 of file kwin.cpp.

References name().

bool KWin::WindowInfo::isOnCurrentDesktop  )  const
 

Returns true if the window is on the currently active virtual desktop.

Requires NET::WMDesktop passed to KWin::windowInfo().

Definition at line 948 of file kwin.cpp.

References KWin::currentDesktop(), and isOnDesktop().

bool KWin::WindowInfo::isOnDesktop int  desktop  )  const
 

Returns true if the window is on the given virtual desktop.

Requires NET::WMDesktop passed to KWin::windowInfo().

Definition at line 957 of file kwin.cpp.

Referenced by isOnCurrentDesktop().

bool KWin::WindowInfo::onAllDesktops  )  const
 

Returns true if the window is on all desktops (equal to desktop()==NET::OnAllDesktops).

Requires NET::WMDesktop passed to KWin::windowInfo().

Definition at line 968 of file kwin.cpp.

int KWin::WindowInfo::desktop  )  const
 

Returns the virtual desktop this window is on (NET::OnAllDesktops if the window is on all desktops).

You should prefer using isOnDesktop(). Requires NET::WMDesktop passed to KWin::windowInfo().

Definition at line 979 of file kwin.cpp.

QRect KWin::WindowInfo::geometry  )  const
 

Returns the position and size of the window contents.

Requires NET::WMGeometry passed to KWin::windowInfo().

Definition at line 990 of file kwin.cpp.

QRect KWin::WindowInfo::frameGeometry  )  const
 

Returns the frame geometry of the window, i.e.

including the window decoration. Requires NET::WMKDEFrameStrut passed to KWin::windowInfo().

Definition at line 1001 of file kwin.cpp.

WId KWin::WindowInfo::transientFor  )  const
 

Returns the WM_TRANSIENT_FOR property for the window, i.e.

the mainwindow for this window. Requires NET::WM2TransientFor passed to KWin::windowInfo().

Definition at line 1008 of file kwin.cpp.

WId KWin::WindowInfo::groupLeader  )  const
 

Returns the leader window for the group the window is in, if any.

Requires NET::WM2GroupLeader passed to KWin::windowInfo().

Definition at line 1019 of file kwin.cpp.

QCString KWin::WindowInfo::windowClassClass  )  const
 

Returns the class component of the window class for the window (i.e.

WM_CLASS property). Requires NET::WM2WindowClass passed to KWin::windowInfo().

Since:
3.3

Definition at line 1030 of file kwin.cpp.

QCString KWin::WindowInfo::windowClassName  )  const
 

Returns the name component of the window class for the window (i.e.

WM_CLASS property). Requires NET::WM2WindowClass passed to KWin::windowInfo().

Since:
3.3

Definition at line 1041 of file kwin.cpp.

QCString KWin::WindowInfo::windowRole  )  const
 

Returns the window role for the window (i.e.

WM_WINDOW_ROLE property). Requires NET::WM2WindowRole passed to KWin::windowInfo().

Since:
3.3

Definition at line 1052 of file kwin.cpp.

QCString KWin::WindowInfo::clientMachine  )  const
 

Returns the client machine for the window (i.e.

WM_CLIENT_MACHINE property). Requires NET::WMClientMachine passed to KWin::windowInfo().

Since:
3.3

Definition at line 1063 of file kwin.cpp.

bool KWin::WindowInfo::actionSupported NET::Action  action  )  const
 

Returns true if the given action is currently supported for the window by the window manager.

Requires NET::WM2AllowedActions passed to KWin::windowInfo().

Definition at line 1074 of file kwin.cpp.

References KWin::allowedActionsSupported().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdecore Library Version 3.3.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jan 22 16:44:10 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003