kwindowsystem.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1999 Matthias Ettrich (ettrich@kde.org)
    Copyright (C) 2007 Lubos Lunak (l.lunak@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
/*
 * kwindowsystem.h. Part of the KDE project.
 */

#ifndef KWINDOWSYSTEM_H
#define KWINDOWSYSTEM_H

#include <kdeui_export.h>
#include <QtCore/QObject>
#include <QtGui/QWidgetList> //For WId
#include <netwm_def.h>
#include <kwindowinfo.h>

class KWindowSystemPrivate;

class KDEUI_EXPORT KWindowSystem : public QObject, public NET
{
    Q_OBJECT

public:
    static KWindowSystem* self();

    static const QList<WId>& windows();

    static bool hasWId(WId id);

    static KWindowInfo windowInfo( WId win, unsigned long properties, unsigned long properties2 = 0 );

    static QList<WId> stackingOrder();

    static WId activeWindow();

    static void activateWindow( WId win, long time = 0 );

    static void forceActiveWindow( WId win, long time = 0 );

    static void demandAttention( WId win, bool set = true );

    static bool compositingActive();

    static int currentDesktop();

    static int numberOfDesktops();

    static void setCurrentDesktop( int desktop );

    static void setOnAllDesktops( WId win, bool b );

    static void setOnDesktop( WId win, int desktop);

    static void setMainWindow( QWidget* subwindow, WId mainwindow );
#ifdef Q_WS_X11

    static WId transientFor( WId window );

    static WId groupLeader( WId window );
#endif

    static QPixmap icon( WId win, int width = -1, int height = -1, bool scale = false );

    enum IconSource { NETWM = 1, 
              WMHints = 2, 
              ClassHint = 4, 
              XApp = 8 
    };
    static QPixmap icon( WId win, int width, int height, bool scale, int flags );

    static void  setIcons( WId win, const QPixmap& icon, const QPixmap& miniIcon );
    static void setType( WId win, NET::WindowType windowType );
    static void setState( WId win, unsigned long state );

    static void clearState( WId win, unsigned long  state );

    static void minimizeWindow( WId win, bool animation = true );

    static void unminimizeWindow( WId win, bool animation = true );

    static void raiseWindow( WId win );

    static void lowerWindow( WId win );

    static bool icccmCompliantMappingState();

    static QRect workArea( int desktop = - 1 );


    static QRect workArea( const QList<WId> &excludes, int desktop = -1);

    static QString desktopName( int desktop );

    static void setDesktopName( int desktop, const QString& name );

    static bool showingDesktop();

    static void setUserTime( WId win, long time );
    static 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 );

    static void setStrut( WId win, int left, int right, int top, int bottom );
    static bool allowedActionsSupported();
    static QString readNameProperty( WId window, unsigned long atom );

    static void doNotManage( const QString& title );

    static void allowExternalProcessWindowActivation( int pid = -1 );

    static void setBlockingCompositing( WId window, bool active );

#ifdef Q_WS_X11

    static bool mapViewport();
    static int viewportToDesktop( const QPoint& pos );
    static int viewportWindowToDesktop( const QRect& r );
    static QPoint desktopToViewport( int desktop, bool absolute );
    static QPoint constrainViewportRelativePosition( const QPoint& pos );
#endif

Q_SIGNALS:

    void currentDesktopChanged( int desktop);

    void windowAdded(WId id);

    void windowRemoved(WId id);

    void activeWindowChanged(WId id);

    void desktopNamesChanged();

    void numberOfDesktopsChanged(int num);

    void workAreaChanged();

    void strutChanged();

    void stackingOrderChanged();

    void windowChanged(WId id, const unsigned long* properties );

    void windowChanged(WId id, unsigned int properties);

    void windowChanged(WId id);

    void showingDesktopChanged( bool showing );

    void compositingChanged( bool enabled );

protected:
    virtual void connectNotify( const char* signal );

private:
    friend class KWindowSystemStaticContainer;

    KWindowSystem() {}

    enum { INFO_BASIC=1, // desktop info, not per-window
           INFO_WINDOWS=2 }; // also per-window info

    static void init(int);

    friend class KWindowSystemPrivate;
    static KWindowSystemPrivate* s_d_func();
};

#endif