taskmanager.h

Go to the documentation of this file.

/*****************************************************************

Copyright (c) 2000-2001 Matthias Elter <elter@kde.org>
Copyright (c) 2001 Richard Moore <rich@kde.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

******************************************************************/

#ifndef __taskmanager_h__
#define __taskmanager_h__

#include <sys/types.h>

#include <netwm.h>

#include <QObject>
#include <QPixmap>
#include <QPoint>
#include <QMimeData>
#include <QMap>
#include <QDrag>
#include <QRect>
#include <QVector>

#include <KSharedPtr>
#include <KStartupInfo>
#include <KWindowSystem>

#if defined(HAVE_XCOMPOSITE) && \
    defined(HAVE_XRENDER) && \
    defined(HAVE_XFIXES)
#include <X11/Xlib.h>
#include <X11/extensions/Xcomposite.h>
#include <X11/extensions/Xfixes.h>
#include <X11/extensions/Xrender.h>
#include <fixx11h.h>
#if XCOMPOSITE_VERSION >= 00200 && \
    XFIXES_VERSION >= 20000 && \
    (RENDER_MAJOR > 0 || RENDER_MINOR >= 6)
#define THUMBNAILING_POSSIBLE
#endif
#endif

#include "superkaramba_export.h"

class KWindowSystem;
class TaskManager;

typedef QList<WId> WindowList;

class SUPERKARAMBA_EXPORT Task: public QObject, public KShared
{
    Q_OBJECT
    Q_PROPERTY(QString visibleName READ visibleName)
    Q_PROPERTY(QString name READ name)
    Q_PROPERTY(QString visibleNameWithState READ visibleNameWithState)
    Q_PROPERTY(QPixmap pixmap READ pixmap)
    Q_PROPERTY(bool maximized READ isMaximized)
    Q_PROPERTY(bool minimized READ isMinimized)
    // KDE4 deprecated
    Q_PROPERTY(bool iconified READ isIconified)
    Q_PROPERTY(bool shaded READ isShaded WRITE setShaded)
    Q_PROPERTY(bool active READ isActive)
    Q_PROPERTY(bool onCurrentDesktop READ isOnCurrentDesktop)
    Q_PROPERTY(bool onAllDesktops READ isOnAllDesktops)
    Q_PROPERTY(bool alwaysOnTop READ isAlwaysOnTop WRITE setAlwaysOnTop)
    Q_PROPERTY(bool modified READ isModified)
    Q_PROPERTY(bool demandsAttention READ demandsAttention)
    Q_PROPERTY(int desktop READ desktop)
    Q_PROPERTY(double thumbnailSize READ thumbnailSize WRITE setThumbnailSize)
    Q_PROPERTY(bool hasThumbnail READ hasThumbnail)
    Q_PROPERTY(QPixmap thumbnail READ thumbnail)

public:
    typedef KSharedPtr<Task> TaskPtr;
    typedef QVector<Task::TaskPtr> List;
    typedef QMap<WId, Task::TaskPtr> Dict;

    Task(WId win, QObject *parent, const char *name = 0);
    virtual ~Task();

    WId window() const
    {
        return _win;
    }
    KWindowInfo info() const
    {
        return _info;
    }

    QString visibleName() const
    {
        return _info.visibleName();
    }
    QString visibleNameWithState() const
    {
        return _info.visibleNameWithState();
    }
    QString name() const
    {
        return _info.name();
    }
    QString className();
    QString classClass();

    WindowList transients() const
    {
        return _transients;
    }

    QPixmap pixmap() const
    {
        return _pixmap;
    }

    QPixmap bestIcon(int size, bool &isStaticIcon);

    QPixmap icon(int width, int height, bool allowResize = false);

    static bool idMatch(const QString &, const QString &);

    // state

    bool isMaximized() const;

    bool isMinimized() const;

    bool isIconified() const;

    bool isShaded() const;

    bool isActive() const;

    bool isOnTop() const;

    bool isOnCurrentDesktop() const;

    bool isOnAllDesktops() const;

    bool isAlwaysOnTop() const;

    bool isKeptBelowOthers() const;

    bool isFullScreen() const;

    bool isModified() const ;

    int desktop() const
    {
        return _info.desktop();
    }

    bool demandsAttention() const;


    bool isOnScreen(int screen) const;

    bool showInTaskbar() const
    {
        return _info.state() ^ NET::SkipTaskbar;
    }

    bool showInPager() const
    {
        return _info.state() ^ NET::SkipPager;
    }

    QRect geometry() const
    {
        return _info.geometry();
    }

    // internal

    //* @internal
    void refresh(unsigned int dirty);
    //* @internal
    void refreshIcon();
    //* @internal
    void addTransient(WId w, const NETWinInfo& info);
    //* @internal
    void removeTransient(WId w);
    //* @internal
    bool hasTransient(WId w) const
    {
        return _transients.indexOf(w) != -1;
    }
    //* @internal
    void updateDemandsAttentionState(WId w);
    //* @internal
    void setActive(bool a);

    // For thumbnails

    double thumbnailSize() const
    {
        return _thumbSize;
    }

    void setThumbnailSize(double size)
    {
        _thumbSize = size;
    }

    bool hasThumbnail() const
    {
        return !_thumb.isNull();
    }

    const QPixmap &thumbnail() const
    {
        return _thumb;
    }

    QPixmap thumbnail(int maxDimension);

    void updateWindowPixmap();

public Q_SLOTS:
    // actions

    void setMaximized(bool);
    void toggleMaximized();

    void restore();

    void move();

    void resize();

    void setIconified(bool);
    void toggleIconified();

    void close();

    void raise();

    void lower();

    void activate();

    void activateRaiseOrIconify();

    void setAlwaysOnTop(bool);
    void toggleAlwaysOnTop();

    void setKeptBelowOthers(bool);
    void toggleKeptBelowOthers();

    void setFullScreen(bool);
    void toggleFullScreen();

    void setShaded(bool);
    void toggleShaded();

    void toDesktop(int);

    void toCurrentDesktop();

    void publishIconGeometry(QRect);

    void updateThumbnail();

Q_SIGNALS:
    void changed();

    void iconChanged();

    void activated();

    void deactivated();

    void thumbnailChanged();

protected Q_SLOTS:
    //* @internal
    void generateThumbnail();

protected:
    void findWindowFrameId();

private:
    bool                _active;
    WId                 _win;
    WId                 m_frameId;
    QPixmap             _pixmap;
    KWindowInfo    _info;
    WindowList          _transients;
    WindowList          _transients_demanding_attention;

    int                 _lastWidth;
    int                 _lastHeight;
    bool                _lastResize;
    QPixmap             _lastIcon;

    double _thumbSize;
    QPixmap _thumb;
    QPixmap _grab;
    QRect m_iconGeometry;
#ifdef THUMBNAILING_POSSIBLE
    Pixmap              m_windowPixmap;
#endif // THUMBNAILING_POSSIBLE
};


class SUPERKARAMBA_EXPORT TaskDrag : public QDrag
{
public:
    explicit TaskDrag(const Task::List& tasks, QWidget* source = 0);
    ~TaskDrag();

    static bool canDecode(const QMimeData* e);

    static Task::List decode(const QMimeData* e);
};


class SUPERKARAMBA_EXPORT Startup: public QObject, public KShared
{
    Q_OBJECT
    Q_PROPERTY(QString text READ text)
    Q_PROPERTY(QString bin READ bin)
    Q_PROPERTY(QString icon READ icon)

public:
    typedef KSharedPtr<Startup> StartupPtr;
    typedef QVector<Startup::StartupPtr> List;

    Startup(const KStartupInfoId& id, const KStartupInfoData& data, QObject * parent,
            const char *name = 0);
    virtual ~Startup();

    QString text() const
    {
        return _data.findName();
    }

    QString bin() const
    {
        return _data.bin();
    }

    QString icon() const
    {
        return _data.findIcon();
    }
    void update(const KStartupInfoData& data);
    const KStartupInfoId& id() const
    {
        return _id;
    }

Q_SIGNALS:
    void changed();

private:
    KStartupInfoId _id;
    KStartupInfoData _data;
    class StartupPrivate *d;
};


class SUPERKARAMBA_EXPORT TaskManager : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int currentDesktop READ currentDesktop)
    Q_PROPERTY(int numberOfDesktops READ numberOfDesktops)

public:
    static TaskManager* self();
    ~TaskManager();

    Task::TaskPtr findTask(WId w);

    Task::TaskPtr findTask(int desktop, const QPoint& p);

    Task::Dict tasks() const
    {
        return m_tasksByWId;
    }

    Startup::List startups() const
    {
        return _startups;
    }

    QString desktopName(int n) const;

    int numberOfDesktops() const;

    int currentDesktop() const;

    bool isOnTop(const Task*);

    void trackGeometry()
    {
        m_trackGeometry = true;
    }

    static bool isOnScreen(int screen, const WId wid);

    KWindowSystem* winModule() const
    {
        return m_winModule;
    }

    void setXCompositeEnabled(bool state);
    static bool xCompositeEnabled()
    {
        return m_xCompositeEnabled != 0;
    }

Q_SIGNALS:
    void activeTaskChanged(Task::TaskPtr);

    void taskAdded(Task::TaskPtr);

    void taskRemoved(Task::TaskPtr);

    void startupAdded(Startup::StartupPtr);

    void startupRemoved(Startup::StartupPtr);

    void desktopChanged(int desktop);

    void windowChanged(Task::TaskPtr);
    void windowChangedGeometry(Task::TaskPtr);

protected Q_SLOTS:
    //* @internal
    void windowAdded(WId);
    //* @internal
    void windowRemoved(WId);
    //* @internal
    void windowChanged(WId, unsigned int);

    //* @internal
    void activeWindowChanged(WId);
    //* @internal
    void currentDesktopChanged(int);
    //* @internal
    void killStartup(const KStartupInfoId&);
    //* @internal
    void killStartup(Startup::StartupPtr);

    //* @internal
    void gotNewStartup(const KStartupInfoId&, const KStartupInfoData&);
    //* @internal
    void gotStartupChange(const KStartupInfoId&, const KStartupInfoData&);

protected:
    void configure_startup();
    void updateWindowPixmap(WId);

private:
    TaskManager();

    Task::TaskPtr               _active;
    Task::Dict m_tasksByWId;
    WindowList _skiptaskbar_windows;
    Startup::List _startups;
    KStartupInfo* _startup_info;
    KWindowSystem* m_winModule;
    bool m_trackGeometry;

    static TaskManager* m_self;
    static uint m_xCompositeEnabled;

    class TaskManagerPrivate *d;
};

#endif