• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDEUI

  • kdeui
  • windowmanagement
kwindowinfo.h
Go to the documentation of this file.
1/* This file is part of the KDE libraries
2 Copyright (C) 1999 Matthias Ettrich (ettrich@kde.org)
3 Copyright (C) 2007 Lubos Lunak (l.lunak@kde.org)
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20/*
21 * kwindowinfo.h. Part of the KDE project.
22 */
23
24#ifndef KWINDOWINFO_H
25#define KWINDOWINFO_H
26
27#include <kdeui_export.h>
28#include <QtGui/QWidgetList> //For WId
29
30#include <netwm_def.h>
31
35class KDEUI_EXPORT KWindowInfo
36{
37public:
41 KWindowInfo( WId window, unsigned long properties, unsigned long properties2 = 0 );
42 KWindowInfo(); // to make QList and others happy
43 ~KWindowInfo();
50 bool valid( bool withdrawn_is_valid = false ) const;
54 WId win() const;
59 unsigned long state() const;
64 bool hasState( unsigned long s ) const;
72 bool isMinimized() const;
79 NET::MappingState mappingState() const;
84 NETExtendedStrut extendedStrut() const;
90 NET::WindowType windowType( int supported_types ) const;
96 QString visibleName() const;
106 QString visibleNameWithState() const;
112 QString name() const;
119 QString visibleIconName() const;
130 QString visibleIconNameWithState() const;
137 QString iconName() const;
142 bool isOnCurrentDesktop() const;
147 bool isOnDesktop( int desktop ) const;
153 bool onAllDesktops() const;
159 int desktop() const;
164 QRect geometry() const;
169 QRect frameGeometry() const;
175 WId transientFor() const;
180 WId groupLeader() const;
181
187 QByteArray windowClassClass() const;
188
194 QByteArray windowClassName() const;
195
200 QByteArray windowRole() const;
201
206 QByteArray clientMachine() const;
207
213 bool actionSupported( NET::Action action ) const;
214
215 KWindowInfo( const KWindowInfo& );
216 KWindowInfo& operator=( const KWindowInfo& );
217private:
218 class Private;
219 Private * d; //krazy:exclude=dpointer (implicitly shared)
220#ifdef Q_WS_MAC
221 // KWindowSystem needs access to the d-pointer
222 friend class KWindowSystem;
223 friend class KWindowSystemPrivate;
224#endif
225};
226
227#endif // multiple inclusion guard
228
KWindowInfo::iconName
QString iconName() const
Returns the name of the window that should be shown in taskbar and all other "iconic" representations...
Definition kwindowinfo_mac.cpp:253
KWindowInfo::extendedStrut
NETExtendedStrut extendedStrut() const
Returns the window extended (partial) strut.
Definition kwindowinfo_mac.cpp:204
KWindowInfo::windowType
NET::WindowType windowType(int supported_types) const
Returns the window type of this window (see NET::WindowType).
Definition kwindowinfo_mac.cpp:210
KWindowInfo::state
unsigned long state() const
Returns the window's state flags (see the NET::State enum for details).
Definition kwindowinfo_mac.cpp:175
KWindowInfo::isMinimized
bool isMinimized() const
Returns true if the window is minimized.
Definition kwindowinfo_mac.cpp:185
KWindowInfo::visibleName
QString visibleName() const
Returns the visible name of the window (i.e.
Definition kwindowinfo_mac.cpp:225
KWindowInfo::valid
bool valid(bool withdrawn_is_valid=false) const
Returns false if this window info is not valid (most probably the given window doesn't exist).
Definition kwindowinfo_mac.cpp:165
KWindowInfo::actionSupported
bool actionSupported(NET::Action action) const
Returns true if the given action is currently supported for the window by the window manager.
Definition kwindowinfo_mac.cpp:288
KWindowInfo::windowClassName
QByteArray windowClassName() const
Returns the name component of the window class for the window (i.e.
Definition kwindowinfo_win.cpp:293
KWindowInfo::windowRole
QByteArray windowRole() const
Returns the window role for the window (i.e.
Definition kwindowinfo_x11.cpp:390
KWindowInfo::visibleIconNameWithState
QString visibleIconNameWithState() const
Returns a visible name with state.
Definition kwindowinfo_mac.cpp:238
KWindowInfo::hasState
bool hasState(unsigned long s) const
Returns true if the window has the given state flag set (see the NET::State enum for details).
Definition kwindowinfo_mac.cpp:180
KWindowInfo::isOnCurrentDesktop
bool isOnCurrentDesktop() const
Returns true if the window is on the currently active virtual desktop.
Definition kwindowinfo_mac.cpp:258
KWindowInfo::visibleNameWithState
QString visibleNameWithState() const
Returns a visible name with state.
Definition kwindowinfo_mac.cpp:215
KWindowInfo::KWindowSystemPrivate
friend class KWindowSystemPrivate
Definition kwindowinfo.h:223
KWindowInfo::KWindowInfo
KWindowInfo(WId window, unsigned long properties, unsigned long properties2=0)
Reads all the info about the given window.
Definition kwindowinfo_mac.cpp:118
KWindowInfo::isOnDesktop
bool isOnDesktop(int desktop) const
Returns true if the window is on the given virtual desktop.
Definition kwindowinfo_mac.cpp:263
KWindowInfo::win
WId win() const
Returns the window identifier.
Definition kwindowinfo_mac.cpp:170
KWindowInfo::KWindowSystem
friend class KWindowSystem
Definition kwindowinfo.h:222
KWindowInfo::transientFor
WId transientFor() const
Returns the WM_TRANSIENT_FOR property for the window, i.e.
Definition kwindowinfo_x11.cpp:354
KWindowInfo::operator=
KWindowInfo & operator=(const KWindowInfo &)
Definition kwindowinfo_mac.cpp:152
KWindowInfo::visibleIconName
QString visibleIconName() const
Returns the visible name of the window that should be shown in taskbar and all other "iconic" represe...
Definition kwindowinfo_mac.cpp:248
KWindowInfo::groupLeader
WId groupLeader() const
Returns the leader window for the group the window is in, if any.
Definition kwindowinfo_x11.cpp:363
KWindowInfo::onAllDesktops
bool onAllDesktops() const
Returns true if the window is on all desktops (equal to desktop()==NET::OnAllDesktops).
Definition kwindowinfo_mac.cpp:268
KWindowInfo::geometry
QRect geometry() const
Returns the position and size of the window contents.
Definition kwindowinfo_mac.cpp:278
KWindowInfo::desktop
int desktop() const
Returns the virtual desktop this window is on (NET::OnAllDesktops if the window is on all desktops).
Definition kwindowinfo_mac.cpp:273
KWindowInfo::windowClassClass
QByteArray windowClassClass() const
Returns the class component of the window class for the window (i.e.
Definition kwindowinfo_win.cpp:277
KWindowInfo::mappingState
NET::MappingState mappingState() const
Returns the mapping state of the window (see NET::MappingState).
Definition kwindowinfo_mac.cpp:199
KWindowInfo::frameGeometry
QRect frameGeometry() const
Returns the frame geometry of the window, i.e.
Definition kwindowinfo_mac.cpp:283
KWindowInfo::clientMachine
QByteArray clientMachine() const
Returns the client machine for the window (i.e.
Definition kwindowinfo_x11.cpp:399
KWindowInfo::name
QString name() const
Returns the name of the window, as specified by the application, without any modifications.
Definition kwindowinfo_mac.cpp:230
NET::WindowType
WindowType
Window type.
Definition netwm_def.h:305
NET::Action
Action
Actions that can be done with a window (_NET_WM_ALLOWED_ACTIONS).
Definition netwm_def.h:553
NET::MappingState
MappingState
Client window mapping state.
Definition netwm_def.h:533
kdeui_export.h
netwm_def.h
NETExtendedStrut
Partial strut class for NET classes.
Definition netwm_def.h:152
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDEUI

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal