QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsVectorLayerSelectionProperties Class Reference

Implementation of layer selection properties for vector layers. More...

#include <qgsvectorlayerselectionproperties.h>

Inheritance diagram for QgsVectorLayerSelectionProperties:
Inheritance graph
[legend]

Public Member Functions

 QgsVectorLayerSelectionProperties (QObject *parent=nullptr)
 Constructor for QgsVectorLayerSelectionProperties, with the specified parent object.
 
 ~QgsVectorLayerSelectionProperties () override
 
QgsVectorLayerSelectionPropertiesclone () const override
 Creates a clone of the properties.
 
bool readXml (const QDomElement &element, const QgsReadWriteContext &context) override
 Reads temporal properties from a DOM element previously written by writeXml().
 
QColor selectionColor () const
 Returns the color to use for rendering selected features in the layer.
 
Qgis::SelectionRenderingMode selectionRenderingMode () const
 Returns the selection rendering mode to use for selected features in the layer.
 
QgsSymbolselectionSymbol () const
 Returns the symbol used to render selected features in the layer.
 
void setSelectionColor (const QColor &color)
 Sets the color to use for rendering selected features in the layer.
 
void setSelectionRenderingMode (Qgis::SelectionRenderingMode mode)
 Sets the selection rendering mode to use for selected features in the layer.
 
void setSelectionSymbol (QgsSymbol *symbol)
 Sets the symbol used to render selected features in the layer.
 
QDomElement writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
 Writes the properties to a DOM element, to be used later with readXml().
 
- Public Member Functions inherited from QgsMapLayerSelectionProperties
 QgsMapLayerSelectionProperties (QObject *parent)
 Constructor for QgsMapLayerSelectionProperties, with the specified parent object.
 

Detailed Description

Implementation of layer selection properties for vector layers.

Since
QGIS 3.34

Definition at line 38 of file qgsvectorlayerselectionproperties.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerSelectionProperties()

QgsVectorLayerSelectionProperties::QgsVectorLayerSelectionProperties ( QObject *  parent = nullptr)

Constructor for QgsVectorLayerSelectionProperties, with the specified parent object.

Definition at line 22 of file qgsvectorlayerselectionproperties.cpp.

◆ ~QgsVectorLayerSelectionProperties()

QgsVectorLayerSelectionProperties::~QgsVectorLayerSelectionProperties ( )
overridedefault

Member Function Documentation

◆ clone()

QgsVectorLayerSelectionProperties * QgsVectorLayerSelectionProperties::clone ( ) const
overridevirtual

Creates a clone of the properties.

Implements QgsMapLayerSelectionProperties.

Definition at line 65 of file qgsvectorlayerselectionproperties.cpp.

◆ readXml()

bool QgsVectorLayerSelectionProperties::readXml ( const QDomElement &  element,
const QgsReadWriteContext context 
)
overridevirtual

Reads temporal properties from a DOM element previously written by writeXml().

See also
writeXml()

Implements QgsMapLayerSelectionProperties.

Definition at line 49 of file qgsvectorlayerselectionproperties.cpp.

◆ selectionColor()

QColor QgsVectorLayerSelectionProperties::selectionColor ( ) const

Returns the color to use for rendering selected features in the layer.

An invalid color indicates that the default (i.e. project level) selection color should be used instead.

See also
setSelectionColor()

Definition at line 74 of file qgsvectorlayerselectionproperties.cpp.

◆ selectionRenderingMode()

Qgis::SelectionRenderingMode QgsVectorLayerSelectionProperties::selectionRenderingMode ( ) const

Returns the selection rendering mode to use for selected features in the layer.

See also
setSelectionRenderingMode()

Definition at line 94 of file qgsvectorlayerselectionproperties.cpp.

◆ selectionSymbol()

QgsSymbol * QgsVectorLayerSelectionProperties::selectionSymbol ( ) const

Returns the symbol used to render selected features in the layer.

May be nullptr if the default symbol should be used instead.

See also
setSelectionSymbol()

Definition at line 84 of file qgsvectorlayerselectionproperties.cpp.

◆ setSelectionColor()

void QgsVectorLayerSelectionProperties::setSelectionColor ( const QColor &  color)

Sets the color to use for rendering selected features in the layer.

An invalid color indicates that the default (i.e. project level) selection color should be used instead.

See also
selectionColor()

Definition at line 79 of file qgsvectorlayerselectionproperties.cpp.

◆ setSelectionRenderingMode()

void QgsVectorLayerSelectionProperties::setSelectionRenderingMode ( Qgis::SelectionRenderingMode  mode)

Sets the selection rendering mode to use for selected features in the layer.

See also
selectionRenderingMode()

Definition at line 99 of file qgsvectorlayerselectionproperties.cpp.

◆ setSelectionSymbol()

void QgsVectorLayerSelectionProperties::setSelectionSymbol ( QgsSymbol symbol)

Sets the symbol used to render selected features in the layer.

Ownership of symbol is transferred to the plot. If symbol is nullptr then the default symbol will be used instead.

See also
selectionSymbol()

Definition at line 89 of file qgsvectorlayerselectionproperties.cpp.

◆ writeXml()

QDomElement QgsVectorLayerSelectionProperties::writeXml ( QDomElement &  element,
QDomDocument &  doc,
const QgsReadWriteContext context 
)
overridevirtual

Writes the properties to a DOM element, to be used later with readXml().

See also
readXml()

Implements QgsMapLayerSelectionProperties.

Definition at line 30 of file qgsvectorlayerselectionproperties.cpp.


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