qgsmaplayerconfigwidgetfactory.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaplayerconfigwidgetfactoryfactory.h
     --------------------------------------
    Date                 : 9.7.2013
    Copyright            : (C) 2013 Matthias Kuhn
    Email                : matthias dot kuhn at gmx dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSMAPLAYERCONFIGWIDGETFACTORY_H
#define QGSMAPLAYERCONFIGWIDGETFACTORY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QListWidgetItem>
 
class QgsMapLayer;
class QgsMapLayerConfigWidget;
class QgsMapCanvas;
class QgsLayerTreeGroup;

class GUI_EXPORT QgsMapLayerConfigWidgetFactory
{
  public:

    enum class ParentPage : int
    {
      NoParent, 
      Temporal, 
    };
 
    QgsMapLayerConfigWidgetFactory() = default;

    QgsMapLayerConfigWidgetFactory( const QString &title, const QIcon &icon );
 
    virtual ~QgsMapLayerConfigWidgetFactory() = default;

    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 bool supportsStyleDock() const { return false; }

    void setSupportsStyleDock( bool supports ) { mSupportsDock = supports; }

    virtual bool supportLayerPropertiesDialog() const { return false; }

    virtual QString layerPropertiesPagePositionHint() const;

    void setSupportLayerPropertiesDialog( bool supports ) { mSupportsProperties = supports; }

    virtual bool supportsLayer( QgsMapLayer *layer ) const;

    virtual bool supportsLayerTreeGroup( QgsLayerTreeGroup *group ) const;

    virtual ParentPage parentPage() const;

    virtual QgsMapLayerConfigWidget *createWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, bool dockWidget = true, QWidget *parent = nullptr ) const = 0 SIP_FACTORY;
 
  private:
    QIcon mIcon;
    QString mTitle;
    bool mSupportsDock = true;
    bool mSupportsProperties = true;
};
 
#endif // QGSMAPLAYERCONFIGWIDGETFACTORY_H