The QgsMapLayerComboBox class is a combo box which displays the list of layers. More...

#include <qgsmaplayercombobox.h>

Inheritance diagram for QgsMapLayerComboBox:

Public Slots
void	setLayer (QgsMapLayer *layer)
	setLayer set the current layer selected in the combo More...

Signals
void	layerChanged (QgsMapLayer *layer)
	Emitted whenever the currently selected layer changes. More...

Public Member Functions
	QgsMapLayerComboBox (QWidget *parent=nullptr)
	QgsMapLayerComboBox creates a combo box to display the list of layers (currently in the registry). More...

QStringList	additionalItems () const
	Returns the list of additional (non map layer) items included at the end of the combo box. More...

QList< QgsMapLayer * >	additionalLayers () const
	Returns the list of additional layers added to the combobox. More...

bool	allowEmptyLayer () const
	Returns `true` if the combo box allows the empty layer ("not set") choice. More...

QgsMapLayer *	currentLayer () const
	Returns the current layer selected in the combo box. More...

QList< QgsMapLayer * >	exceptedLayerList () const
	returns the list of excepted layers More...

QStringList	excludedProviders () const
	Returns the list of data providers which are excluded from the combobox. More...

QgsMapLayerProxyModel::Filters	filters () const
	currently used filter on list layers More...

QgsMapLayer *	layer (int layerIndex) const
	Returns the layer currently shown at the specified index within the combo box. More...

void	setAdditionalItems (const QStringList &items)
	Sets a list of additional (non map layer) items to include at the end of the combobox. More...

void	setAdditionalLayers (const QList< QgsMapLayer * > &layers)
	Sets a list of additional layers to include in the combobox. More...

void	setAllowEmptyLayer (bool allowEmpty, const QString &text=QString(), const QIcon &icon=QIcon())
	Sets whether an optional empty layer ("not set") option is shown in the combo box. More...

void	setExceptedLayerList (const QList< QgsMapLayer * > &layerList)
	except a list of layers not to be listed More...

void	setExcludedProviders (const QStringList &providers)
	Sets a list of data providers which should be excluded from the combobox. More...

void	setFilters (QgsMapLayerProxyModel::Filters filters)
	setFilters allows filtering according to layer type and/or geometry type. More...

void	setProject (QgsProject *project)
	Sets the project from which map layers are shown. More...

void	setShowCrs (bool showCrs)
	Sets whether the CRS of layers is also included in the combo box text. More...

bool	showCrs () const
	Returns `true` if the combo box shows the layer's CRS. More...

Protected Slots
void	indexChanged (int i)

void	rowsChanged ()

Protected Member Functions
void	dragEnterEvent (QDragEnterEvent *event) override

void	dragLeaveEvent (QDragLeaveEvent *event) override

void	dropEvent (QDropEvent *event) override

void	paintEvent (QPaintEvent *e) override

Properties
bool	allowEmptyLayer

QStringList	excludedProviders

QgsMapLayerProxyModel::Filters	filters

bool	showCrs

Friends
class	QgsProcessingMapLayerComboBox

Detailed Description

The QgsMapLayerComboBox class is a combo box which displays the list of layers.

Since: QGIS 2.3

Definition at line 34 of file qgsmaplayercombobox.h.

Constructor & Destructor Documentation

◆ QgsMapLayerComboBox()

QgsMapLayerComboBox::QgsMapLayerComboBox ( QWidget * parent = nullptr )

explicit

QgsMapLayerComboBox creates a combo box to display the list of layers (currently in the registry).

The layers can be filtered and/or ordered.

Definition at line 22 of file qgsmaplayercombobox.cpp.

Member Function Documentation

◆ additionalItems()

QStringList QgsMapLayerComboBox::additionalItems ( ) const

Returns the list of additional (non map layer) items included at the end of the combo box.

See also: setAdditionalItems()

Since: QGIS 3.0

Definition at line 78 of file qgsmaplayercombobox.cpp.

◆ additionalLayers()

QList< QgsMapLayer * > QgsMapLayerComboBox::additionalLayers ( ) const

Returns the list of additional layers added to the combobox.

See also: setAdditionalLayers()

Since: QGIS 3.22

Definition at line 88 of file qgsmaplayercombobox.cpp.

◆ allowEmptyLayer()

bool QgsMapLayerComboBox::allowEmptyLayer ( ) const

Returns true if the combo box allows the empty layer ("not set") choice.

See also: setAllowEmptyLayer()

Since: QGIS 3.0

◆ currentLayer()

QgsMapLayer * QgsMapLayerComboBox::currentLayer ( ) const

Returns the current layer selected in the combo box.

See also: layer

Definition at line 120 of file qgsmaplayercombobox.cpp.

◆ dragEnterEvent()

void QgsMapLayerComboBox::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

Definition at line 182 of file qgsmaplayercombobox.cpp.

◆ dragLeaveEvent()

void QgsMapLayerComboBox::dragLeaveEvent ( QDragLeaveEvent * event )

overrideprotected

Definition at line 204 of file qgsmaplayercombobox.cpp.

◆ dropEvent()

void QgsMapLayerComboBox::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 218 of file qgsmaplayercombobox.cpp.

◆ exceptedLayerList()

QList<QgsMapLayer *> QgsMapLayerComboBox::exceptedLayerList ( ) const

inline

returns the list of excepted layers

Definition at line 60 of file qgsmaplayercombobox.h.

◆ excludedProviders()

QStringList QgsMapLayerComboBox::excludedProviders ( ) const

Returns the list of data providers which are excluded from the combobox.

See also: setExcludedProviders()

Since: QGIS 3.0

◆ filters()

QgsMapLayerProxyModel::Filters QgsMapLayerComboBox::filters ( ) const

inline

currently used filter on list layers

Definition at line 54 of file qgsmaplayercombobox.h.

◆ indexChanged

void QgsMapLayerComboBox::indexChanged ( int i )

protectedslot

Definition at line 147 of file qgsmaplayercombobox.cpp.

◆ layer()

QgsMapLayer * QgsMapLayerComboBox::layer ( int layerIndex ) const

Returns the layer currently shown at the specified index within the combo box.

Parameters

layerIndex position of layer to return

See also: currentLayer

Since: QGIS 2.10

Definition at line 125 of file qgsmaplayercombobox.cpp.

◆ layerChanged

void QgsMapLayerComboBox::layerChanged ( QgsMapLayer * layer )

signal

Emitted whenever the currently selected layer changes.

◆ paintEvent()

void QgsMapLayerComboBox::paintEvent ( QPaintEvent * e )

overrideprotected

Definition at line 243 of file qgsmaplayercombobox.cpp.

◆ rowsChanged

void QgsMapLayerComboBox::rowsChanged ( )

protectedslot

Definition at line 154 of file qgsmaplayercombobox.cpp.

◆ setAdditionalItems()

void QgsMapLayerComboBox::setAdditionalItems ( const QStringList & items )

Sets a list of additional (non map layer) items to include at the end of the combobox.

These may represent additional layers such as layers which are not included in the map layer registry, or paths to layers which have not yet been loaded into QGIS.

See also: additionalItems()

Since: QGIS 3.0

Definition at line 73 of file qgsmaplayercombobox.cpp.

◆ setAdditionalLayers()

void QgsMapLayerComboBox::setAdditionalLayers ( const QList< QgsMapLayer * > & layers )

Sets a list of additional layers to include in the combobox.

This method allows adding additional layers, which are not part of a project's layers, into the combobox.

See also: additionalLayers()

Since: QGIS 3.22

Definition at line 83 of file qgsmaplayercombobox.cpp.

◆ setAllowEmptyLayer()

void QgsMapLayerComboBox::setAllowEmptyLayer	(	bool	allowEmpty,
		const QString &	text = `QString()`,
		const QIcon &	icon = `QIcon()`
	)

Sets whether an optional empty layer ("not set") option is shown in the combo box.

Since QGIS 3.20, the optional text and icon arguments allows the text and icon for the empty layer item to be set.

See also: allowEmptyLayer()

Since: QGIS 3.0

Definition at line 53 of file qgsmaplayercombobox.cpp.

◆ setExceptedLayerList()

void QgsMapLayerComboBox::setExceptedLayerList ( const QList< QgsMapLayer * > & layerList )

inline

except a list of layers not to be listed

Definition at line 57 of file qgsmaplayercombobox.h.

◆ setExcludedProviders()

void QgsMapLayerComboBox::setExcludedProviders ( const QStringList & providers )

Sets a list of data providers which should be excluded from the combobox.

See also: excludedProviders()

Since: QGIS 3.0

Definition at line 37 of file qgsmaplayercombobox.cpp.

◆ setFilters()

void QgsMapLayerComboBox::setFilters ( QgsMapLayerProxyModel::Filters filters )

inline

setFilters allows filtering according to layer type and/or geometry type.

Definition at line 51 of file qgsmaplayercombobox.h.

◆ setLayer

void QgsMapLayerComboBox::setLayer ( QgsMapLayer * layer )

slot

setLayer set the current layer selected in the combo

Definition at line 93 of file qgsmaplayercombobox.cpp.

◆ setProject()

void QgsMapLayerComboBox::setProject ( QgsProject * project )

Sets the project from which map layers are shown.

If project is nullptr then QgsProject::instance() will be used.

Since: QGIS 3.24

Definition at line 42 of file qgsmaplayercombobox.cpp.

◆ setShowCrs()

void QgsMapLayerComboBox::setShowCrs ( bool showCrs )

Sets whether the CRS of layers is also included in the combo box text.

See also: showCrs()

Since: QGIS 3.0

Definition at line 63 of file qgsmaplayercombobox.cpp.

◆ showCrs()

bool QgsMapLayerComboBox::showCrs ( ) const

Returns true if the combo box shows the layer's CRS.

See also: setShowCrs()

Since: QGIS 3.0

Friends And Related Function Documentation

◆ QgsProcessingMapLayerComboBox

friend class QgsProcessingMapLayerComboBox

friend

Definition at line 196 of file qgsmaplayercombobox.h.

Property Documentation

◆ allowEmptyLayer

bool QgsMapLayerComboBox::allowEmptyLayer

readwrite

Definition at line 38 of file qgsmaplayercombobox.h.

◆ excludedProviders

QStringList QgsMapLayerComboBox::excludedProviders

readwrite

Definition at line 40 of file qgsmaplayercombobox.h.

◆ filters

QgsMapLayerProxyModel::Filters QgsMapLayerComboBox::filters

readwrite

Definition at line 37 of file qgsmaplayercombobox.h.

◆ showCrs

bool QgsMapLayerComboBox::showCrs

readwrite

Definition at line 39 of file qgsmaplayercombobox.h.

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

/build/qgis-3.26.3+32focal/src/gui/qgsmaplayercombobox.h
/build/qgis-3.26.3+32focal/src/gui/qgsmaplayercombobox.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QgsMapLayerComboBox()

Member Function Documentation

◆ additionalItems()

◆ additionalLayers()

◆ allowEmptyLayer()

◆ currentLayer()

◆ dragEnterEvent()

◆ dragLeaveEvent()

◆ dropEvent()

◆ exceptedLayerList()

◆ excludedProviders()

◆ filters()

◆ indexChanged

◆ layer()

◆ layerChanged

◆ paintEvent()

◆ rowsChanged

◆ setAdditionalItems()

◆ setAdditionalLayers()

◆ setAllowEmptyLayer()

◆ setExceptedLayerList()

◆ setExcludedProviders()

◆ setFilters()

◆ setLayer

◆ setProject()

◆ setShowCrs()

◆ showCrs()

Friends And Related Function Documentation

◆ QgsProcessingMapLayerComboBox

Property Documentation

◆ allowEmptyLayer

◆ excludedProviders

◆ filters

◆ showCrs