Class: QgsProviderSublayersDialog

Dialog for selecting provider sublayers.

Added in version 3.30.

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

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

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

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])