windoweffects.h

Go to the documentation of this file.

/*
 *   Copyright 2009 Marco Martin <notmart@gmail.com>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_WINDOWEFFECTS_H
#define PLASMA_WINDOWEFFECTS_H

#include <QtGui/QWidget>

#include <plasma/plasma.h>

namespace Plasma
{

namespace WindowEffects
{
    enum Effect {
        Slide = 1,
        WindowPreview = 2,
        PresentWindows = 3,
        PresentWindowsGroup = 4,
        HighlightWindows = 5,
        OverrideShadow = 6,
        BlurBehind = 7,
        Dashboard = 8
    };

    PLASMA_EXPORT bool isEffectAvailable(Effect effect);

    PLASMA_EXPORT void slideWindow(WId id, Plasma::Location location, int offset);

    PLASMA_EXPORT void slideWindow(QWidget *widget, Plasma::Location location);

    PLASMA_EXPORT QList<QSize> windowSizes(const QList<WId> &ids);

    PLASMA_EXPORT void showWindowThumbnails(WId parent, const QList<WId> &windows = QList<WId>(), const QList<QRect> &rects = QList<QRect>());

    PLASMA_EXPORT void presentWindows(WId controller, const QList<WId> &ids);

    PLASMA_EXPORT void presentWindows(WId controller, int desktop = -1);

    PLASMA_EXPORT void highlightWindows(WId controller, const QList<WId> &ids);

    PLASMA_EXPORT void overrideShadow(WId window, bool override);

    PLASMA_EXPORT void enableBlurBehind(WId window, bool enable = true, const QRegion &region = QRegion());

    PLASMA_EXPORT void markAsDashboard(WId window);
}

} // namespace Plasma

#endif