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: Enums
Methods
Returns the list of additional (non map layer) items included at the end of the combo box.
Returns
True
if the combo box allows the empty layer (“not set”) choice.Returns the current layer selected in the combo box.
returns the list of excepted layers
Returns the list of data providers which are excluded from the combobox.
currently used filter on list layers
Returns the layer currently shown at the specified index within the combo box.
Sets a list of additional (non map layer) items to include at the end of the combobox.
Sets whether an optional empty layer (“not set”) option is shown in the combo box.
except a list of layers not to be listed
Sets a list of data providers which should be excluded from the combobox.
setFilters allows fitering according to layer type and/or geometry type.
setLayer set the current layer selected in the combo
Sets whether the CRS of layers is also included in the combo box text.
Returns
True
if the combo box shows the layer’s CRS.Signals
Emitted whenever the currently selected layer changes.
Attributes
-
actionEvent
()¶
-
additionalItems
(self) → List[str]¶ Returns the list of additional (non map layer) items included at the end of the combo box.
See also
New in version 3.0.
-
allowEmptyLayer
(self) → bool¶ Returns
True
if the combo box allows the empty layer (“not set”) choice.See also
New in version 3.0.
-
changeEvent
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
()¶
-
currentLayer
(self) → QgsMapLayer¶ Returns the current layer selected in the combo box.
See also
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
(self, event: QDragEnterEvent)¶
-
dragLeaveEvent
(self, event: QDragLeaveEvent)¶
-
dragMoveEvent
()¶
-
dropEvent
(self, event: QDropEvent)¶
-
enterEvent
()¶
-
exceptedLayerList
(self) → List[QgsMapLayer]¶ returns the list of excepted layers
-
excludedProviders
(self) → List[str]¶ Returns the list of data providers which are excluded from the combobox.
See also
New in version 3.0.
-
filters
(self) → QgsMapLayerProxyModel.Filters¶ currently used filter on list layers
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
indexChanged
(self, 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 – position of layer to return
See also
New in version 2.10.
-
layerChanged
¶ Emitted whenever the currently selected layer changes. [signal]
-
leaveEvent
()¶
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
(self, 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.
See also
New in version 3.0.
-
setAllowEmptyLayer
(self, allowEmpty: bool)¶ Sets whether an optional empty layer (“not set”) option is shown in the combo box.
See also
New in version 3.0.
-
setExceptedLayerList
(self, layerList: Iterable[QgsMapLayer])¶ except a list of layers not to be listed
-
setExcludedProviders
(self, providers: Iterable[str])¶ Sets a list of data providers which should be excluded from the combobox.
See also
New in version 3.0.
-
setFilters
(self, filters: Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter])¶ setFilters allows fitering according to layer type and/or geometry type.
-
setLayer
(self, layer: QgsMapLayer)¶ setLayer set the current layer selected in the combo
-
setShowCrs
(self, showCrs: bool)¶ Sets whether the CRS of layers is also included in the combo box text.
See also
New in version 3.0.
-
showCrs
(self) → bool¶ Returns
True
if the combo box shows the layer’s CRS.See also
New in version 3.0.
-
showEvent
()¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶
-