plasma-framework/glapplet.h

/*
 *   Copyright 2007 Zack Rusin <zack@kde.org>
 *
 *   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_GLAPPLET_H
#define PLASMA_GLAPPLET_H

#include <plasma/applet.h>

#include <QtOpenGL/QGLWidget>

namespace Plasma
{

class GLAppletPrivate;

/**
 * @class GLApplet plasma/glapplet.h <Plasma/GLApplet>
 *
 * @short Plasma Applet that is fully rendered using OpengGL
 */
class PLASMA_EXPORT_DEPRECATED GLApplet : public Applet
{
    Q_OBJECT

    public:
        /**
         * @param parent the QGraphicsItem this applet is parented to
         * @param serviceId the name of the .desktop file containing the
         *      information about the widget
         * @param appletId a unique id used to differentiate between multiple
         *      instances of the same Applet type
         */
        GLApplet(QGraphicsItem *parent,
                 const QString &serviceId,
                 int appletId);

        /**
         * This constructor is to be used with the plugin loading systems
         * found in KPluginInfo and KService. The argument list is expected
         * to have two elements: the KService service ID for the desktop entry
         * and an applet ID which must be a base 10 number.
         *
         * @param parent a QObject parent; you probably want to pass in 0
         * @param args a list of strings containing two entries: the service id
         *      and the applet id
         */
        GLApplet(QObject *parent, const QVariantList &args);

        ~GLApplet();

        GLuint bindTexture(const QImage &image, GLenum target = GL_TEXTURE_2D);
        void deleteTexture(GLuint texture_id);

        /**
         * Reimplement this method to render using OpenGL. QPainter passed
         * to this method will always use OpenGL engine and rendering
         * using OpenGL api directly is supported.
         */
        virtual void paintGLInterface(QPainter *painter,
                                      const QStyleOptionGraphicsItem *option);
        void makeCurrent();
    private:
        virtual void paintInterface(QPainter *painter,
                                    const QStyleOptionGraphicsItem *option,
                                    const QRect &contentsRect);
    private:
        GLAppletPrivate *const d;
};

}

#endif