workspace/kwin/toplevel.h

   1 /********************************************************************
   2  KWin - the KDE window manager
   3  This file is part of the KDE project.
   4
   5 Copyright (C) 2006 Lubos Lunak <l.lunak@kde.org>
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 *********************************************************************/
  20
  21 #ifndef KWIN_TOPLEVEL_H
  22 #define KWIN_TOPLEVEL_H
  23
  24 #include <config-X11.h>
  25
  26 #include <assert.h>
  27 #include <QObject>
  28 #include <kdecoration.h>
  29 #include <kdebug.h>
  30
  31 #include "utils.h"
  32 #include "workspace.h"
  33
  34 #ifdef HAVE_XDAMAGE
  35 #include <X11/extensions/Xdamage.h>
  36 #endif
  37
  38 class NETWinInfo2;
  39
  40 namespace KWin
  41 {
  42
  43 class Workspace;
  44 class EffectWindowImpl;
  45
  46 class Toplevel
  47     : public QObject, public KDecorationDefines
  48     {
  49     Q_OBJECT
  50     public:
  51         Toplevel( Workspace *ws );
  52         Window frameId() const;
  53         Window window() const;
  54         Workspace* workspace() const;
  55         QRect geometry() const;
  56         QSize size() const;
  57         QPoint pos() const;
  58         QRect rect() const;
  59         int x() const;
  60         int y() const;
  61         int width() const;
  62         int height() const;
  63         bool isOnScreen( int screen ) const; // true if it's at least partially there
  64         int screen() const; // the screen where the center is
  65         virtual QPoint clientPos() const = 0; // inside of geometry()
  66         virtual QSize clientSize() const = 0;
  67
  68         // prefer isXXX() instead
  69         // 0 for supported types means default for managed/unmanaged types
  70         NET::WindowType windowType( bool direct = false, int supported_types = 0 ) const;
  71         bool hasNETSupport() const;
  72         bool isDesktop() const;
  73         bool isDock() const;
  74         bool isToolbar() const;
  75         bool isTopMenu() const;
  76         bool isMenu() const;
  77         bool isNormalWindow() const; // normal as in 'NET::Normal or NET::Unknown non-transient'
  78         bool isDialog() const;
  79         bool isSplash() const;
  80         bool isUtility() const;
  81         bool isDropdownMenu() const;
  82         bool isPopupMenu() const; // a context popup, not dropdown, not torn-off
  83         bool isTooltip() const;
  84         bool isNotification() const;
  85         bool isComboBox() const;
  86         bool isDNDIcon() const;
  87
  88         virtual int desktop() const = 0;
  89         bool isOnDesktop( int d ) const;
  90         bool isOnCurrentDesktop() const;
  91         bool isOnAllDesktops() const;
  92
  93         QByteArray windowRole() const;
  94         QByteArray sessionId();
  95         QByteArray resourceName() const;
  96         QByteArray resourceClass() const;
  97         QByteArray wmCommand();
  98         QByteArray wmClientMachine( bool use_localhost ) const;
  99         Window wmClientLeader() const;
 100         pid_t pid() const;
 101         static bool resourceMatch( const Toplevel* c1, const Toplevel* c2 );
 102
 103         Pixmap windowPixmap( bool allow_create = true ); // may return None (e.g. at a bad moment while resizing)
 104         bool readyForPainting() const; // true if the window has been already painted its contents
 105         Visual* visual() const;
 106         bool shape() const;
 107         void setOpacity( double opacity );
 108         double opacity() const;
 109         int depth() const;
 110         bool hasAlpha() const;
 111         virtual void setupCompositing();
 112         virtual void finishCompositing();
 113         bool updateUnredirectedState();
 114         bool unredirected() const;
 115         void suspendUnredirect( bool suspend );
 116         void addRepaint( const QRect& r );
 117         void addRepaint( int x, int y, int w, int h );
 118         void addRepaintFull();
 119         // these call workspace->addRepaint(), but first transform the damage if needed
 120         void addWorkspaceRepaint( const QRect& r );
 121         void addWorkspaceRepaint( int x, int y, int w, int h );
 122         QRegion repaints() const;
 123         void resetRepaints( const QRect& r );
 124         QRegion damage() const;
 125         void resetDamage( const QRect& r );
 126         EffectWindowImpl* effectWindow();
 127
 128     protected:
 129         virtual ~Toplevel();
 130         void setWindowHandles( Window client, Window frame );
 131         void detectShape( Window id );
 132         virtual void propertyNotifyEvent( XPropertyEvent* e );
 133 #ifdef HAVE_XDAMAGE
 134         virtual void damageNotifyEvent( XDamageNotifyEvent* e );
 135 #endif
 136         Pixmap createWindowPixmap();
 137         void discardWindowPixmap();
 138         void addDamage( const QRect& r );
 139         void addDamage( int x, int y, int w, int h );
 140         void addDamageFull();
 141         void getWmClientLeader();
 142         void getWmClientMachine();
 143         void getResourceClass();
 144         void getWindowRole();
 145         virtual void debug( kdbgstream& stream ) const = 0;
 146         void copyToDeleted( Toplevel* c );
 147         void disownDataPassedToDeleted();
 148         friend kdbgstream& operator<<( kdbgstream& stream, const Toplevel* );
 149         void deleteEffectWindow();
 150         virtual bool shouldUnredirect() const = 0;
 151         QRect geom;
 152         Visual* vis;
 153         int bit_depth;
 154         NETWinInfo2* info;
 155         bool ready_for_painting;
 156     private:
 157         static QByteArray staticWindowRole(WId);
 158         static QByteArray staticSessionId(WId);
 159         static QByteArray staticWmCommand(WId);
 160         static QByteArray staticWmClientMachine(WId);
 161         static Window staticWmClientLeader(WId);
 162         // when adding new data members, check also copyToDeleted()
 163         Window client;
 164         Window frame;
 165         Workspace* wspace;
 166         Pixmap window_pix;
 167 #ifdef HAVE_XDAMAGE
 168         Damage damage_handle;
 169 #endif
 170         QRegion damage_region; // damage is really damaged window (XDamage) and texture needs
 171         QRegion repaints_region; // updating, repaint just requires repaint of that area
 172         bool is_shape;
 173         EffectWindowImpl* effect_window;
 174         QByteArray resource_name;
 175         QByteArray resource_class;
 176         QByteArray client_machine;
 177         WId wmClientLeaderWin;
 178         QByteArray window_role;
 179         bool unredirect;
 180         bool unredirectSuspend; // when unredirected, but pixmap is needed temporarily
 181         // when adding new data members, check also copyToDeleted()
 182     };
 183
 184 inline Window Toplevel::window() const
 185     {
 186     return client;
 187     }
 188
 189 inline Window Toplevel::frameId() const
 190     {
 191     return frame;
 192     }
 193
 194 inline void Toplevel::setWindowHandles( Window w, Window f )
 195     {
 196     assert( client == None && w != None );
 197     client = w;
 198     assert( frame == None && f != None );
 199     frame = f;
 200     }
 201
 202 inline Workspace* Toplevel::workspace() const
 203     {
 204     return wspace;
 205     }
 206
 207 inline QRect Toplevel::geometry() const
 208     {
 209     return geom;
 210     }
 211
 212 inline QSize Toplevel::size() const
 213     {
 214     return geom.size();
 215     }
 216
 217 inline QPoint Toplevel::pos() const
 218     {
 219     return geom.topLeft();
 220     }
 221
 222 inline int Toplevel::x() const
 223     {
 224     return geom.x();
 225     }
 226
 227 inline int Toplevel::y() const
 228     {
 229     return geom.y();
 230     }
 231
 232 inline int Toplevel::width() const
 233     {
 234     return geom.width();
 235     }
 236
 237 inline int Toplevel::height() const
 238     {
 239     return geom.height();
 240     }
 241
 242 inline QRect Toplevel::rect() const
 243     {
 244     return QRect( 0, 0, width(), height());
 245     }
 246
 247 inline bool Toplevel::readyForPainting() const
 248     {
 249     return ready_for_painting;
 250     }
 251
 252 inline Visual* Toplevel::visual() const
 253     {
 254     return vis;
 255     }
 256
 257 inline bool Toplevel::isDesktop() const
 258     {
 259     return windowType() == NET::Desktop;
 260     }
 261
 262 inline bool Toplevel::isDock() const
 263     {
 264     return windowType() == NET::Dock;
 265     }
 266
 267 inline bool Toplevel::isTopMenu() const
 268     {
 269     return windowType() == NET::TopMenu;
 270     }
 271
 272 inline bool Toplevel::isMenu() const
 273     {
 274     return windowType() == NET::Menu && !isTopMenu(); // because of backwards comp.
 275     }
 276
 277 inline bool Toplevel::isToolbar() const
 278     {
 279     return windowType() == NET::Toolbar;
 280     }
 281
 282 inline bool Toplevel::isSplash() const
 283     {
 284     return windowType() == NET::Splash;
 285     }
 286
 287 inline bool Toplevel::isUtility() const
 288     {
 289     return windowType() == NET::Utility;
 290     }
 291
 292 inline bool Toplevel::isDialog() const
 293     {
 294     return windowType() == NET::Dialog;
 295     }
 296
 297 inline bool Toplevel::isNormalWindow() const
 298     {
 299     return windowType() == NET::Normal;
 300     }
 301
 302 inline bool Toplevel::isDropdownMenu() const
 303     {
 304     return windowType() == NET::DropdownMenu;
 305     }
 306
 307 inline bool Toplevel::isPopupMenu() const
 308     {
 309     return windowType() == NET::PopupMenu;
 310     }
 311
 312 inline bool Toplevel::isTooltip() const
 313     {
 314     return windowType() == NET::Tooltip;
 315     }
 316
 317 inline bool Toplevel::isNotification() const
 318     {
 319     return windowType() == NET::Notification;
 320     }
 321
 322 inline bool Toplevel::isComboBox() const
 323     {
 324     return windowType() == NET::ComboBox;
 325     }
 326
 327 inline bool Toplevel::isDNDIcon() const
 328     {
 329     return windowType() == NET::DNDIcon;
 330     }
 331
 332 inline Pixmap Toplevel::windowPixmap( bool allow_create )
 333     {
 334     if( window_pix == None && allow_create )
 335         window_pix = createWindowPixmap();
 336     return window_pix;
 337     }
 338
 339 inline QRegion Toplevel::damage() const
 340     {
 341     return damage_region;
 342     }
 343
 344 inline QRegion Toplevel::repaints() const
 345     {
 346     return repaints_region;
 347     }
 348
 349 inline bool Toplevel::shape() const
 350     {
 351     return is_shape;
 352     }
 353
 354 inline int Toplevel::depth() const
 355     {
 356     return bit_depth;
 357     }
 358
 359 inline bool Toplevel::hasAlpha() const
 360     {
 361     return depth() == 32;
 362     }
 363
 364 inline
 365 EffectWindowImpl* Toplevel::effectWindow()
 366     {
 367     return effect_window;
 368     }
 369
 370 inline bool Toplevel::isOnAllDesktops() const
 371     {
 372     return desktop() == NET::OnAllDesktops;
 373     }
 374
 375 inline bool Toplevel::isOnDesktop( int d ) const
 376     {
 377     return desktop() == d || /*desk == 0 ||*/ isOnAllDesktops();
 378     }
 379
 380 inline bool Toplevel::isOnCurrentDesktop() const
 381     {
 382     return isOnDesktop( workspace()->currentDesktop());
 383     }
 384
 385 inline QByteArray Toplevel::resourceName() const
 386     {
 387     return resource_name; // it is always lowercase
 388     }
 389
 390 inline QByteArray Toplevel::resourceClass() const
 391     {
 392     return resource_class; // it is always lowercase
 393     }
 394
 395 inline QByteArray Toplevel::windowRole() const
 396     {
 397     return window_role;
 398     }
 399
 400 inline pid_t Toplevel::pid() const
 401     {
 402     return info->pid();
 403     }
 404
 405 inline bool Toplevel::unredirected() const
 406     {
 407     return unredirect;
 408     }
 409
 410 kdbgstream& operator<<( kdbgstream& stream, const Toplevel* );
 411 kdbgstream& operator<<( kdbgstream& stream, const ToplevelList& );
 412 kdbgstream& operator<<( kdbgstream& stream, const ConstToplevelList& );
 413
 414 KWIN_COMPARE_PREDICATE( WindowMatchPredicate, Toplevel, Window, cl->window() == value );
 415 KWIN_COMPARE_PREDICATE( FrameIdMatchPredicate, Toplevel, Window, cl->frameId() == value );
 416
 417 } // namespace
 418
 419 #endif