Class: QgsMapLayerComboBox

class qgis.gui.QgsMapLayerComboBox(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QComboBox

QgsMapLayerComboBox creates a combo box to display the list of layers (currently in the registry). The layers can be filtered and/or ordered.

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

New in version 2.3.

Parameters

parent

actionEvent()
additionalItems(self) → List[str]

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

New in version 3.0.

Return type

List[str]

allowEmptyLayer(self) → bool

Returns True if the combo box allows the empty layer (“not set”) choice.

New in version 3.0.

Return type

bool

changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
currentLayer(self) → QgsMapLayer

Returns the current layer selected in the combo box.

See also

layer()

Return type

QgsMapLayer

customEvent()
destroy()
disconnectNotify()
dragEnterEvent(self, event: QDragEnterEvent)
Parameters

event (QDragEnterEvent) –

dragLeaveEvent(self, event: QDragLeaveEvent)
Parameters

event (QDragLeaveEvent) –

dragMoveEvent()
dropEvent(self, event: QDropEvent)
Parameters

event (QDropEvent) –

enterEvent()
exceptedLayerList(self) → List[QgsMapLayer]

returns the list of excepted layers

Return type

List[QgsMapLayer]

excludedProviders(self) → List[str]

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

New in version 3.0.

Return type

List[str]

filters(self) → QgsMapLayerProxyModel.Filters

currently used filter on list layers

Return type

QgsMapLayerProxyModel.Filters

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
indexChanged(self, i: int)
Parameters

i (int) –

initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
layer(self, layerIndex: int) → QgsMapLayer

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

Parameters

layerIndex (int) – position of layer to return

See also

currentLayer()

New in version 2.10.

Return type

QgsMapLayer

layerChanged

Emitted whenever the currently selected layer changes. [signal]

Parameters

layer (QgsMapLayer) –

leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent(self, e: QPaintEvent)
Parameters

e (QPaintEvent) –

receivers()
resizeEvent()
rowsChanged(self)
sender()
senderSignalIndex()
setAdditionalItems(self, items: Iterable[str])

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.

New in version 3.0.

Parameters

items (Iterable[str]) –

setAllowEmptyLayer(self, allowEmpty: bool)

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

New in version 3.0.

Parameters

allowEmpty (bool) –

setExceptedLayerList(self, layerList: Iterable[QgsMapLayer])

except a list of layers not to be listed

Parameters

layerList (Iterable[QgsMapLayer]) –

setExcludedProviders(self, providers: Iterable[str])

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

New in version 3.0.

Parameters

providers (Iterable[str]) –

setFilters(self, filters: Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter])

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

Parameters

filters (Union[QgsMapLayerProxyModel.Filters) –

setLayer(self, layer: QgsMapLayer)

setLayer set the current layer selected in the combo

Parameters

layer (QgsMapLayer) –

setShowCrs(self, showCrs: bool)

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

See also

showCrs()

New in version 3.0.

Parameters

showCrs (bool) –

sharedPainter()
showCrs(self) → bool

Returns True if the combo box shows the layer’s CRS.

See also

setShowCrs()

New in version 3.0.

Return type

bool

showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()