RenderPlugin.h

Go to the documentation of this file.

//
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2008      Torsten Rahn <tackat@kde.org>
// Copyright 2008      Inge Wallin  <inge@lysator.liu.se>
// Copyright 2011,2012 Bernhard Beschow <bbeschow@cs.tu-berlin.de>
// Copyright 2012      Illya Kovalevskyy <illya.kovalevskyy@gmail.com>
//

#ifndef MARBLE_RENDERPLUGIN_H
#define MARBLE_RENDERPLUGIN_H

#include <QObject>
#include <QString>
#include <Qt>

#include "RenderPluginInterface.h"
#include "marble_export.h"


class QAction;
class QActionGroup;
class QStandardItem;

namespace Marble
{

class MarbleModel;
class RenderPluginModel;

class MARBLE_EXPORT RenderPlugin : public QObject, public RenderPluginInterface
{
    Q_OBJECT

    Q_PROPERTY ( QString name READ name CONSTANT )
    Q_PROPERTY ( QString nameId READ nameId CONSTANT )
    Q_PROPERTY ( QString version READ version CONSTANT )
    Q_PROPERTY ( QString description READ description CONSTANT )
    Q_PROPERTY ( bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged )
    Q_PROPERTY ( bool visible READ visible WRITE setVisible NOTIFY visibilityChanged )
    Q_PROPERTY ( bool userCheckable READ isUserCheckable WRITE setUserCheckable NOTIFY userCheckableChanged )

 public:
    enum RenderType {
        UnknownRenderType,
        TopLevelRenderType,
        PanelRenderType,
        OnlineRenderType,
        ThemeRenderType
    };

    explicit RenderPlugin( const MarbleModel *marbleModel );
    virtual ~RenderPlugin();

    virtual QString guiString() const = 0;

    virtual RenderPlugin *newInstance( const MarbleModel *marbleModel ) const = 0;

    const MarbleModel* marbleModel() const;

    virtual const QList<QActionGroup*>*   actionGroups() const;

    virtual const QList<QActionGroup*>*   toolbarActionGroups() const;

    bool    enabled() const;

    bool    visible() const;

    bool    isUserCheckable() const;

    virtual QHash<QString,QVariant> settings() const;

    virtual void setSettings( const QHash<QString,QVariant> &settings );

    virtual RenderType renderType() const;

    RenderState renderState() const;

    virtual QString runtimeTrace() const;

 public Q_SLOTS:
    void    setEnabled( bool enabled );

    void    setVisible( bool visible );

    void    setUserCheckable(bool isUserCheckable);

    void    restoreDefaultSettings();

    QStringList settingKeys() const;

    bool setSetting( const QString & key, const QVariant & value );

    QVariant setting( const QString & key ) const;

    QAction *action() const;

 Q_SIGNALS:
    void visibilityChanged( bool visible, const QString &nameId );

    void enabledChanged( bool enable );

    void userCheckableChanged(bool isUserCheckable);

    void settingsChanged( QString nameId );

    void actionGroupsChanged();

    void repaintNeeded( QRegion dirtyRegion = QRegion() );

 protected:
    bool eventFilter( QObject *, QEvent * );

 private:
    friend class RenderPluginModel;

    QStandardItem *item();

    void applyItemState();
    void retrieveItemState();

 private:
    Q_DISABLE_COPY( RenderPlugin )
    class Private;
    Private * const d;
};

#define MARBLE_PLUGIN(T) public:\
    virtual RenderPlugin* newInstance( const MarbleModel *marbleModel ) const { return new T( marbleModel ); }
}

#endif