qgsmaplayerconfigwidget.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmaplayerconfigwidget.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/




class QgsMapLayerConfigWidget : QgsPanelWidget
{
%Docstring
A panel widget that can be shown in the map style dock

.. versionadded:: 2.16
%End

%TypeHeaderCode
#include "qgsmaplayerconfigwidget.h"
%End
  public:

    QgsMapLayerConfigWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = 0 );
%Docstring
A panel widget that can be shown in the map style dock

:param layer: The layer active in the dock.
:param canvas: The canvas object.
:param parent: The parent of the widget.

.. note::

   The widget is created each time the panel is selected in the dock.
   Keep the loading light as possible for speed in the UI.
%End

    virtual bool shouldTriggerLayerRepaint() const;
%Docstring
Whether this config widget changes map layer properties in a way that triggerRepaint() should
be called for the layer after applying changes. This is true by default, but some config widgets
(for example 3D rendering config) do not need layer repaint as they do not modify 2D map rendering.

.. versionadded:: 3.8
%End

    virtual void syncToLayer( QgsMapLayer *layer );
%Docstring
Reset to original (vector layer) values

.. versionadded:: 3.14
%End

  public slots:

    virtual void apply() = 0;
%Docstring
Called when changes to the layer need to be made.
Will be called when live update is enabled.
%End

  protected:
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmaplayerconfigwidget.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/