QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | List of all members
QgsMapLayerStyle Class Reference

Stores style information (renderer, transparency, labeling, diagrams etc.) applicable to a map layer. More...

#include <qgsmaplayerstylemanager.h>

Public Member Functions

 QgsMapLayerStyle ()
 construct invalid style More...
 
 QgsMapLayerStyle (const QString &xmlData)
 construct style from QML definition (XML) More...
 
void clear ()
 Remove any stored style data (will get invalid) More...
 
bool isValid () const
 Tell whether the style is valid (i.e. there is something stored in it) More...
 
void readFromLayer (QgsMapLayer *layer)
 Store layer's active style information in the instance. More...
 
void readXml (const QDomElement &styleElement)
 Read style configuration (for project file reading) More...
 
void writeToLayer (QgsMapLayer *layer) const
 Apply stored layer's style information to the layer. More...
 
void writeXml (QDomElement &styleElement) const
 Write style configuration (for project file writing) More...
 
QString xmlData () const
 Return XML content of the style. More...
 

Detailed Description

Stores style information (renderer, transparency, 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.

Note
added in 2.8

Definition at line 37 of file qgsmaplayerstylemanager.h.

Constructor & Destructor Documentation

QgsMapLayerStyle::QgsMapLayerStyle ( )

construct invalid style

Definition at line 209 of file qgsmaplayerstylemanager.cpp.

QgsMapLayerStyle::QgsMapLayerStyle ( const QString xmlData)
explicit

construct style from QML definition (XML)

Definition at line 213 of file qgsmaplayerstylemanager.cpp.

Member Function Documentation

void QgsMapLayerStyle::clear ( )

Remove any stored style data (will get invalid)

Definition at line 223 of file qgsmaplayerstylemanager.cpp.

bool QgsMapLayerStyle::isValid ( ) const

Tell whether the style is valid (i.e. there is something stored in it)

Definition at line 218 of file qgsmaplayerstylemanager.cpp.

void QgsMapLayerStyle::readFromLayer ( QgsMapLayer layer)

Store layer's active style information in the instance.

Definition at line 233 of file qgsmaplayerstylemanager.cpp.

void QgsMapLayerStyle::readXml ( const QDomElement styleElement)

Read style configuration (for project file reading)

Definition at line 265 of file qgsmaplayerstylemanager.cpp.

void QgsMapLayerStyle::writeToLayer ( QgsMapLayer layer) const

Apply stored layer's style information to the layer.

Definition at line 249 of file qgsmaplayerstylemanager.cpp.

void QgsMapLayerStyle::writeXml ( QDomElement styleElement) const

Write style configuration (for project file writing)

Definition at line 272 of file qgsmaplayerstylemanager.cpp.

QString QgsMapLayerStyle::xmlData ( ) const

Return XML content of the style.

Definition at line 228 of file qgsmaplayerstylemanager.cpp.


The documentation for this class was generated from the following files: