qgsmaplayerstyle.sip.in

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






class QgsMapLayerStyle
{
%Docstring
Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer.

Stored data are considered as opaque - it is not possible to access them directly or modify them - it is
only possible to read or write layer's current style.

.. versionadded:: 2.8
%End

%TypeHeaderCode
#include "qgsmaplayerstyle.h"
%End
  public:
    static const QMetaObject staticMetaObject;

  public:

    enum StyleCategory
    {
      LayerConfiguration,
      Symbology,
      Labels,
      Fields,
      Forms,
      Actions,
      MapTips,
      Diagrams,
      AttributeTable,
      Rendering,
      CustomProperties,
      All
    };
    typedef QFlags<QgsMapLayerStyle::StyleCategory> StyleCategories;


    QgsMapLayerStyle();
%Docstring
construct invalid style
%End

    explicit QgsMapLayerStyle( const QString &xmlData );
%Docstring
construct style from QML definition (XML)
%End

    bool isValid() const;
%Docstring
Tell whether the style is valid (i.e. there is something stored in it)
%End

    void clear();
%Docstring
Remove any stored style data (will get invalid)
%End

    QString xmlData() const;
%Docstring
Returns XML content of the style
%End

    void readFromLayer( QgsMapLayer *layer );
%Docstring
Store layer's active style information in the instance
%End
    void writeToLayer( QgsMapLayer *layer ) const;
%Docstring
Apply stored layer's style information to the layer
%End

    void readXml( const QDomElement &styleElement );
%Docstring
Read style configuration (for project file reading)
%End
    void writeXml( QDomElement &styleElement ) const;
%Docstring
Write style configuration (for project file writing)
%End

};

QFlags<QgsMapLayerStyle::StyleCategory> operator|(QgsMapLayerStyle::StyleCategory f1, QFlags<QgsMapLayerStyle::StyleCategory> f2);



class QgsMapLayerStyleOverride
{
%Docstring
Restore overridden layer style on destruction.

.. versionadded:: 3.2
%End

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

    QgsMapLayerStyleOverride( QgsMapLayer *layer );
%Docstring
Construct a style override object associated with a map layer.
The overridden style will be restored upon object destruction.
%End

    ~QgsMapLayerStyleOverride();

    void setOverrideStyle( const QString &style );
%Docstring
Temporarily apply a different style to the layer. The argument
can be either a style name or a full QML style definition.
%End

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