Class: QgsProviderSublayersDialog

Dialog for selecting provider sublayers.

Added in version 3.30.

List of all members, including inherited members

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

Constructor

__init__

Methods

groupName	Returns an appropriate name for the layer group.
selectedLayers	Returns the list of selected layers.
selectedNonLayerItems	Returns the list of selected non-layer items (e.g. embedded QGIS project items).
setGroupName	Sets an appropriate name for the layer group.
setNonLayerItems	Set list of non-layer items (e.g. embedded QGIS project items).

Signals

layersAdded

Emitted when sublayers selected from the dialog should be added to the project.

class qgis.gui.QgsProviderSublayersDialog

Bases: QDialog

__init__(uri: str | None, providerKey: str | None, filePath: str | None, initialDetails: Iterable[QgsProviderSublayerDetails] = [], acceptableTypes: Iterable[Qgis.LayerType] = [], parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor.

Parameters:

• uri (Optional[str])

• providerKey (Optional[str])

• filePath (Optional[str])

• initialDetails (Iterable[QgsProviderSublayerDetails] = [])

• acceptableTypes (Iterable[Qgis.LayerType] = [])

• parent (Optional[QWidget] = None)

• fl (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

groupName(self) → str

Returns an appropriate name for the layer group.

Return type:

str

signal layersAdded(layers: List[QgsProviderSublayerDetails])

Emitted when sublayers selected from the dialog should be added to the project.

Parameters:

layers (List[QgsProviderSublayerDetails])

selectedLayers(self) → list[QgsProviderSublayerDetails]

Returns the list of selected layers.

Return type:

list[QgsProviderSublayerDetails]

selectedNonLayerItems(self) → list[QgsProviderSublayerModel.NonLayerItem]

Returns the list of selected non-layer items (e.g. embedded QGIS project items).

Return type:

list[QgsProviderSublayerModel.NonLayerItem]

setGroupName(self, groupNameIn: str | None)

Sets an appropriate name for the layer group.

Parameters:

groupNameIn (Optional[str])

setNonLayerItems(self, items: Iterable[QgsProviderSublayerModel.NonLayerItem])

Set list of non-layer items (e.g. embedded QGIS project items).

Parameters:

items (Iterable[QgsProviderSublayerModel.NonLayerItem])