qgsoptionswidgetfactory.h

Go to the documentation of this file.

/***************************************************************************
    qgsoptionswidgetfactory.h
     -------------------------------
    Date                 : March 2017
    Copyright            : (C) 2017 Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSOPTIONSWIDGETFACTORY_H
#define QGSOPTIONSWIDGETFACTORY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsoptionsdialoghighlightwidget.h"
 
#include <QListWidgetItem>

class GUI_EXPORT QgsOptionsPageWidget : public QWidget
{
    Q_OBJECT
 
  public:
    QgsOptionsPageWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr )
      : QWidget( parent )
    {}

    virtual QString helpKey() const { return QString(); }

    QHash<QWidget *, QgsOptionsDialogHighlightWidget *> registeredHighlightWidgets() SIP_SKIP { return mHighlightWidgets; }

    virtual bool isValid() { return true; }
 
  public slots:

    virtual void apply() = 0;

    virtual void cancel() { return; }
 
  protected:
    void registerHighlightWidget( QgsOptionsDialogHighlightWidget *highlightWidget ) { mHighlightWidgets.insert( highlightWidget->widget(), highlightWidget ); }
 
  private:
    QHash<QWidget *, QgsOptionsDialogHighlightWidget *> mHighlightWidgets;
};

// NOTE - this is a QObject so we can detect its destruction and avoid
// QGIS crashing when a plugin crashes/exits without deregistering a factory
class GUI_EXPORT QgsOptionsWidgetFactory : public QObject
{
    Q_OBJECT
 
  public:
    QgsOptionsWidgetFactory() = default;

    QgsOptionsWidgetFactory( const QString &title, const QIcon &icon, const QString &key = QString() )
      : mTitle( title )
      , mIcon( icon )
      , mKey( key )
    {}

    virtual QIcon icon() const { return mIcon; }

    void setIcon( const QIcon &icon ) { mIcon = icon; }

    virtual QString title() const { return mTitle; }

    void setTitle( const QString &title ) { mTitle = title; }

    virtual QString key() const { return mKey; }

    void setKey( const QString &key ) { mKey = key; }

    virtual QString pagePositionHint() const { return QString(); }

    virtual QStringList path() const { return QStringList(); }

    virtual QgsOptionsPageWidget *createWidget( QWidget *parent = nullptr ) const = 0 SIP_FACTORY;
 
  private:
    QString mTitle;
    QIcon mIcon;
    QString mKey;
};
 
#endif // QGSOPTIONSWIDGETFACTORY_H