• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KWindowInfo Class Reference

#include <kwindowinfo.h>

List of all members.


Detailed Description

Information about a window.

Definition at line 37 of file kwindowinfo.h.


Public Member Functions

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

Constructor & Destructor Documentation

KWindowInfo::KWindowInfo ( WId  window,
unsigned long  properties,
unsigned long  properties2 = 0 
)

Reads all the info about the given window.

Definition at line 101 of file kwindowinfo_mac.cpp.

KWindowInfo::KWindowInfo (  ) 

Definition at line 114 of file kwindowinfo_mac.cpp.

KWindowInfo::~KWindowInfo (  ) 

Definition at line 119 of file kwindowinfo_mac.cpp.

KWindowInfo::KWindowInfo ( const KWindowInfo &  wininfo  ) 

Definition at line 128 of file kwindowinfo_mac.cpp.


Member Function Documentation

bool KWindowInfo::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 271 of file kwindowinfo_mac.cpp.

QByteArray KWindowInfo::clientMachine (  )  const

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

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

Definition at line 372 of file kwindowinfo_x11.cpp.

int KWindowInfo::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 256 of file kwindowinfo_mac.cpp.

NETExtendedStrut KWindowInfo::extendedStrut (  )  const

Returns the window extended (partial) strut.

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

Definition at line 187 of file kwindowinfo_mac.cpp.

QRect KWindowInfo::frameGeometry (  )  const

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

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

Definition at line 266 of file kwindowinfo_mac.cpp.

QRect KWindowInfo::geometry (  )  const

Returns the position and size of the window contents.

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

Definition at line 261 of file kwindowinfo_mac.cpp.

WId KWindowInfo::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 344 of file kwindowinfo_x11.cpp.

bool KWindowInfo::hasState ( unsigned long  s  )  const

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

Definition at line 163 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 236 of file kwindowinfo_mac.cpp.

bool KWindowInfo::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 168 of file kwindowinfo_mac.cpp.

bool KWindowInfo::isOnCurrentDesktop (  )  const

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

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

Definition at line 241 of file kwindowinfo_mac.cpp.

bool KWindowInfo::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 246 of file kwindowinfo_mac.cpp.

NET::MappingState KWindowInfo::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 182 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 213 of file kwindowinfo_mac.cpp.

bool KWindowInfo::onAllDesktops (  )  const

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

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

Definition at line 251 of file kwindowinfo_mac.cpp.

KWindowInfo & KWindowInfo::operator= ( const KWindowInfo &  wininfo  ) 

Definition at line 135 of file kwindowinfo_mac.cpp.

unsigned long KWindowInfo::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 158 of file kwindowinfo_mac.cpp.

WId KWindowInfo::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 337 of file kwindowinfo_x11.cpp.

bool KWindowInfo::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 148 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 231 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 221 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 208 of file kwindowinfo_mac.cpp.

QString KWindowInfo::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 198 of file kwindowinfo_mac.cpp.

WId KWindowInfo::win (  )  const

Returns the window identifier.

Definition at line 153 of file kwindowinfo_mac.cpp.

QByteArray KWindowInfo::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().

Definition at line 351 of file kwindowinfo_x11.cpp.

QByteArray KWindowInfo::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().

Definition at line 358 of file kwindowinfo_x11.cpp.

QByteArray KWindowInfo::windowRole (  )  const

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

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

Definition at line 365 of file kwindowinfo_x11.cpp.

NET::WindowType KWindowInfo::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 193 of file kwindowinfo_mac.cpp.


The documentation for this class was generated from the following files:
  • kwindowinfo.h
  • kwindowinfo_mac.cpp
  • kwindowinfo_x11.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal