Class: QgsMapLayerComboBox

class qgis.gui.QgsMapLayerComboBox

Bases: PyQt5.QtWidgets.QComboBox

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

New in version 2.3.

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

Methods

actionEvent

additionalItems

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

allowEmptyLayer

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

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

currentLayer

Returns the current layer selected in the combo box.

customEvent

destroy

disconnectNotify

dragEnterEvent

param event

dragLeaveEvent

param event

dragMoveEvent

dropEvent

param event

enterEvent

exceptedLayerList

returns the list of excepted layers

excludedProviders

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

filters

currently used filter on list layers

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

indexChanged

param i

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

layer

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

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

param e

receivers

resizeEvent

rowsChanged

sender

senderSignalIndex

setAdditionalItems

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

setAllowEmptyLayer

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

setExceptedLayerList

except a list of layers not to be listed

setExcludedProviders

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

setFilters

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

setLayer

setLayer set the current layer selected in the combo

setShowCrs

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

sharedPainter

showCrs

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

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

layerChanged

Emitted whenever the currently selected layer changes.

actionEvent(self, QActionEvent)
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(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
currentLayer(self)QgsMapLayer

Returns the current layer selected in the combo box.

See also

layer()

Return type

QgsMapLayer

customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, event: QDragEnterEvent)
Parameters

event (QDragEnterEvent) –

dragLeaveEvent(self, event: QDragLeaveEvent)
Parameters

event (QDragLeaveEvent) –

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

event (QDropEvent) –

enterEvent(self, QEvent)
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(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
indexChanged(self, i: int)
Parameters

i (int) –

initPainter(self, QPainter)
initStyleOption(self, QStyleOptionComboBox)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
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(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, e: QPaintEvent)
Parameters

e (QPaintEvent) –

receivers(self, PYQT_SIGNAL)int
resizeEvent(self, QResizeEvent)
rowsChanged(self)
sender(self)QObject
senderSignalIndex(self)int
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, text: str = '', icon: QIcon = 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.

New in version 3.0.

Parameters
  • allowEmpty (bool) –

  • text (str = '') –

  • icon (QIcon = QIcon()) –

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 filtering 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(self)QPainter
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(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)