qgssettingseditorwidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingseditorwidgetwrapper.h
  --------------------------------------
  Date                 : February 2023
  Copyright            : (C) 2023 by Denis Rouzaud
  Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSSETTINGSEDITORWIDGETWRAPPER_H
#define QGSSETTINGSEDITORWIDGETWRAPPER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QVariant>
 
class QgsSettingsEntryBase;
 
class QDialog;

class GUI_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
{
    Q_OBJECT
  public:
    static QgsSettingsEditorWidgetWrapper *fromWidget( const QWidget *widget );

    QgsSettingsEditorWidgetWrapper( QObject *parent = nullptr );
 
    ~QgsSettingsEditorWidgetWrapper() override = default;

    virtual QString id() const = 0;

    virtual QgsSettingsEditorWidgetWrapper *createWrapper( QObject *parent = nullptr ) const = 0 SIP_FACTORY;

    QWidget *createEditor( const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList = QStringList(), QWidget *parent = nullptr ) SIP_TRANSFERBACK;

    bool configureEditor( QWidget *editor, const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList = QStringList() );

    virtual bool setWidgetFromSetting() const = 0;

    virtual bool setSettingFromWidget() const = 0;

    virtual QVariant variantValueFromWidget() const = 0;

    virtual bool setWidgetFromVariant( const QVariant &value ) const = 0;

    void configureAutomaticUpdate( QDialog *dialog = nullptr );

    QStringList dynamicKeyPartList() const { return mDynamicKeyPartList; }
 
 
  protected:
    virtual QWidget *createEditorPrivate( QWidget *parent = nullptr ) const = 0 SIP_TRANSFERBACK;

    virtual bool configureEditorPrivate( QWidget *editor SIP_TRANSFERBACK, const QgsSettingsEntryBase *setting SIP_KEEPREFERENCE ) = 0;

    virtual void enableAutomaticUpdatePrivate() = 0;
 
    QStringList mDynamicKeyPartList;
};
 
 
#endif // QGSSETTINGSEDITORWIDGETWRAPPER_H