Class: QgsZipItem

class qgis.core.QgsZipItem

Bases: QgsDataCollectionItem

A zip file: contains layers, using GDAL/OGR VSIFILE mechanism

QgsZipItem(parent: QgsDataItem, name: str, path: str) Constructor

QgsZipItem(parent: QgsDataItem, name: str, filePath: str, path: str, providerKey: str = ‘’) Constructor

Methods

childEvent

connectNotify

createChildren

rtype

object

customEvent

deferredDelete

The item is scheduled to be deleted.

disconnectNotify

getZipFileList

rtype

List[str]

homeDirIcon

Shared home directory icon.

iconZip

rtype

QIcon

isSignalConnected

itemFromFilePath

Creates a new data item from the specified path.

itemFromPath

Creates a new data item from the specified path.

openDirIcon

Shared open directory icon.

populate

populate(self, foreground: bool = False)

receivers

refresh

Refresh the items from a specified list of child items.

sender

senderSignalIndex

timerEvent

updateIcon

Will request a repaint of this icon.

vsiPrefix

param uri

Attributes

sProviderNames

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
createChildren(self)object
Return type

object

customEvent(self, QEvent)
deferredDelete(self)bool

The item is scheduled to be deleted. E.g. if deleteLater() is called when item is in Populating state (createChildren() running in another thread), the deferredDelete() returns True and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns True and return from createChildren() immediately because result will be useless.

disconnectNotify(self, QMetaMethod)
getZipFileList(self)List[str]
Return type

List[str]

homeDirIcon()QIcon

Shared home directory icon.

New in version 3.4.

iconZip()QIcon
Return type

QIcon

isSignalConnected(self, QMetaMethod)bool
itemFromFilePath(parent: QgsDataItem, filePath: str, name: str, path: str)QgsDataItem

Creates a new data item from the specified path.

Note

available in Python as itemFromFilePath

Parameters
  • parent (QgsDataItem) –

  • filePath (str) –

  • name (str) –

  • path (str) –

Return type

QgsDataItem

itemFromPath(parent: QgsDataItem, path: str, name: str)QgsDataItem

Creates a new data item from the specified path.

Parameters
  • parent (QgsDataItem) –

  • path (str) –

  • name (str) –

Return type

QgsDataItem

openDirIcon()QIcon

Shared open directory icon.

New in version 3.4.

populate(self, children: object)

populate(self, foreground: bool = False)

receivers(self, PYQT_SIGNAL)int
refresh(self, children: object)

Refresh the items from a specified list of child items.

refresh(self)

sProviderNames = []
sender(self)QObject
senderSignalIndex(self)int
timerEvent(self, QTimerEvent)
updateIcon(self)

Will request a repaint of this icon.

New in version 3.0.

vsiPrefix(uri: str)str
Parameters

uri (str) –

Return type

str