QGIS/python/gui/auto_generated/symbology/qgssymbollayerwidget.sip.in

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




class QgsSymbolLayerWidget : QWidget, protected QgsExpressionContextGenerator
{

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

    QgsSymbolLayerWidget( QWidget *parent /TransferThis/, QgsVectorLayer *vl = 0 );
%Docstring
Constructor for QgsSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer ) = 0;
    virtual QgsSymbolLayer *symbolLayer() = 0;

    virtual void setContext( const QgsSymbolWidgetContext &context );
%Docstring
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

:param context: symbol widget context

.. seealso:: :py:func:`context`

.. versionadded:: 3.0
%End

    QgsSymbolWidgetContext context() const;
%Docstring
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

.. seealso:: :py:func:`setContext`

.. versionadded:: 3.0
%End

    const QgsVectorLayer *vectorLayer() const;
%Docstring
Returns the vector layer associated with the widget.

.. versionadded:: 2.12
%End

  protected:

    void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key );
%Docstring
Registers a data defined override button. Handles setting up connections
for the button and initializing the button to show the correct descriptions
and help text for the associated property.

.. versionadded:: 3.0
%End

    virtual QgsExpressionContext createExpressionContext() const;


  signals:

    void changed();
%Docstring
Should be emitted whenever configuration changes happened on this symbol layer configuration.
If the subsymbol is changed, symbolChanged() should be emitted instead.
%End

    void symbolChanged();
%Docstring
Should be emitted whenever the sub symbol changed on this symbol layer configuration.
Normally changed() should be preferred.

.. seealso:: :py:func:`changed`
%End

  protected slots:
    void updateDataDefinedProperty();

};




class QgsSimpleLineSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsSimpleLineSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleLineSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleLineSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

    void updatePatternIcon();

    virtual void resizeEvent( QResizeEvent *event );


};




class QgsSimpleMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsSimpleMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleMarkerSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleMarkerSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:

    void setColorStroke( const QColor &color );
    void setColorFill( const QColor &color );

  protected:

};




class QgsSimpleFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsSimpleFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:
    void setColor( const QColor &color );
    void setStrokeColor( const QColor &color );

  protected:

};





class QgsFilledMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring
Widget for configuring QgsFilledMarkerSymbolLayer symbol layers.

.. versionadded:: 2.16
%End

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

    QgsFilledMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsFilledMarkerSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsFilledMarkerSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

};




class QgsGradientFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsGradientFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsGradientFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsGradientFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:
    void setColor( const QColor &color );
    void setColor2( const QColor &color );

    void applyColorRamp();
%Docstring
Applies the color ramp passed on by the color ramp button
%End
    void setGradientType( int index );
    void setCoordinateMode( int index );
    void setGradientSpread( int index );

  protected:

};




class QgsShapeburstFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsShapeburstFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsShapeburstFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsShapeburstFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:
    void setColor( const QColor &color );
    void setColor2( const QColor &color );

  protected:

};




class QgsMarkerLineSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsMarkerLineSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsMarkerLineSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsMarkerLineSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:

    void setInterval( double val );
    void setOffsetAlongLine( double val );

  protected:


};




class QgsHashedLineSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring
Widget for controlling the properties of a :py:class:`QgsHashedLineSymbolLayer`.

.. versionadded:: 3.8
%End

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

    QgsHashedLineSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsHashedLineSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsHashedLineSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


};




class QgsSvgMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsSvgMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSvgMarkerSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSvgMarkerSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


    virtual void setContext( const QgsSymbolWidgetContext &context );


  protected:

    void populateList();
    void setGuiForSvg( const QgsSvgMarkerSymbolLayer *layer );


};




class QgsRasterMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring
Widget for configuring QgsRasterMarkerSymbolLayer symbol layers.

.. versionadded:: 3.6
%End

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

    QgsRasterMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRasterMarkerSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsRasterMarkerSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();

    virtual void setContext( const QgsSymbolWidgetContext &context );


  protected:


};




class QgsRasterFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsRasterFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRasterFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsRasterFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

};




class QgsSVGFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsSVGFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSVGFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSVGFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();

    virtual void setContext( const QgsSymbolWidgetContext &context );


  protected:
    void insertIcons();

    void updateParamGui( bool resetValues = true );
%Docstring
Enables or disables svg fill color, stroke color and stroke width based on whether the
svg file supports custom parameters.

:param resetValues: set to ``True`` to overwrite existing layer fill color, stroke color and stroke width
                    with default values from svg file
%End

};




class QgsLinePatternFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsLinePatternFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsLinePatternFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsLinePatternFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

};




class QgsPointPatternFillSymbolLayerWidget: QgsSymbolLayerWidget
{

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

    QgsPointPatternFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsPointPatternFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsPointPatternFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

};





class QgsRandomMarkerFillSymbolLayerWidget: QgsSymbolLayerWidget
{
%Docstring

Widget for controlling the properties of a :py:class:`QgsRandomMarkerFillSymbolLayer`.

.. versionadded:: 3.12
%End

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

    QgsRandomMarkerFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRandomMarkerFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsRandomMarkerFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


};




class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsFontMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsFontMarkerSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsFontMarkerSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  public slots:
    void setFontFamily( const QFont &font );
    void setColor( const QColor &color );

    void setColorStroke( const QColor &color );
%Docstring
Set stroke color.

.. versionadded:: 2.16
%End
    void setSize( double size );
    void setAngle( double angle );

    void setCharacter( QChar chr );
%Docstring
Set the font marker character from char.

:param chr: the char
%End

    void setCharacterFromText( const QString &text );
%Docstring
Set the font marker character from a text string.

:param text: the text string

.. versionadded:: 3.8
%End

  protected:

};





class QgsCentroidFillSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsCentroidFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsCentroidFillSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsCentroidFillSymbolLayerWidget.

:param vl: associated vector layer
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


  protected:

};




class QgsGeometryGeneratorSymbolLayerWidget : QgsSymbolLayerWidget
{

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

    QgsGeometryGeneratorSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsGeometryGeneratorSymbolLayerWidget.

:param vl: associated vector layer
:param parent: parent widget
%End

    static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Will be registered as factory
%End

    virtual void setSymbolLayer( QgsSymbolLayer *layer );

    virtual QgsSymbolLayer *symbolLayer();


};

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