Class: QgsSublayersDialog

class qgis.gui.QgsSublayersDialog(providerType: QgsSublayersDialog.ProviderType, name: str, parent: QWidget = None, fl: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags(), dataSourceUri: str = '')

Bases: PyQt5.QtWidgets.QDialog

Construct a new QgsSublayersDialog object - a dialog to select which sub layers to be imported from a data source (e.g. from geopackage or zipfile)

Parameters
Gdal = 1
class LayerDefinition

Bases: sip.wrapper

QgsSublayersDialog.LayerDefinition(QgsSublayersDialog.LayerDefinition)

count
description
layerId
layerName
type
Mdal = 3
Ogr = 0
PromptAlways = 0
PromptIfNeeded = 1
PromptLoadAll = 3
class PromptMode

Bases: int

baseClass

alias of qgis._gui.QgsSublayersDialog

PromptNever = 2
class ProviderType

Bases: int

Vsifile = 2
actionEvent(self, QActionEvent)
addToGroupCheckbox(self) → bool

If we should add layers in a group

New in version 3.0.

Return type

bool

changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
countColumn(self) → int

Returns column with count or -1

New in version 3.0.

Return type

int

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
exec(self) → int
Return type

int

focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) → bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
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, QPaintEvent)
populateLayerTable(self, list: Iterable[QgsSublayersDialog.LayerDefinition])

Populate the table with layers

New in version 2.16.

Parameters

list (Iterable[QgsSublayersDialog.LayerDefinition]) –

receivers(self, PYQT_SIGNAL) → int
resizeEvent(self, QResizeEvent)
selection(self) → List[QgsSublayersDialog.LayerDefinition]

Returns list of selected layers

New in version 2.16.

Return type

List[QgsSublayersDialog.LayerDefinition]

sender(self) → QObject
senderSignalIndex(self) → int
setShowAddToGroupCheckbox(self, showAddToGroupCheckbox: bool)

Set if we should display the add to group checkbox

New in version 3.0.

Parameters

showAddToGroupCheckbox (bool) –

sharedPainter(self) → QPainter
showAddToGroupCheckbox(self) → bool

If we should display the add to group checkbox

New in version 3.0.

Return type

bool

showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)