qgsmaplayerconfigwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaplayerconfigwidget.h
    -------------------------
    begin                : June 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                : woodrow dot nathan 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 QGSMAPLAYERCONFIGWIDGET_H
#define QGSMAPLAYERCONFIGWIDGET_H
 
#include "qgis_gui.h"
#include "qgslayertreegroup.h"
#include "qgspanelwidget.h"
 
#include <QIcon>
#include <QPointer>
#include <QWidget>
 
class QgsMapCanvas;
class QgsMapLayer;
class QgsMessageBar;

class GUI_EXPORT QgsMapLayerConfigWidgetContext
{
  public:

    QString annotationId() const { return mAnnotationId; }

    void setAnnotationId( const QString &id ) { mAnnotationId = id; }

    void setMapCanvas( QgsMapCanvas *canvas ) { mMapCanvas = canvas; }

    QgsMapCanvas *mapCanvas() const { return mMapCanvas; }

    void setMessageBar( QgsMessageBar *bar ) { mMessageBar = bar; }

    QgsMessageBar *messageBar() const { return mMessageBar; }

    void setLayerTreeGroup( QgsLayerTreeGroup *group );

    QgsLayerTreeGroup *layerTreeGroup() const;
 
  private:
    QString mAnnotationId;
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
    QPointer<QgsLayerTreeGroup> mLayerTreeGroup = nullptr;
};
 

class GUI_EXPORT QgsMapLayerConfigWidget : public QgsPanelWidget
{
    Q_OBJECT
  public:

    QgsMapLayerConfigWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = nullptr );

    virtual bool shouldTriggerLayerRepaint() const { return true; }
 
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
#endif

    virtual void syncToLayer( QgsMapLayer *layer ) { Q_UNUSED( layer ) }
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif

    virtual void setMapLayerConfigWidgetContext( const QgsMapLayerConfigWidgetContext &context );
 
  public slots:

    virtual void apply() = 0;

    virtual void focusDefaultWidget();
 
  signals:
 
#ifndef SIP_RUN

    void dynamicTemporalControlToggled( bool enabled );
#endif
 
  protected:
    QgsMapLayer *mLayer = nullptr;
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext;
};
 
#endif // QGSMAPLAYERCONFIGWIDGET_H