Class: QgsCptCityArchive

class qgis.core.QgsCptCityArchive(archiveName: str | None = '', baseDir: str | None = '')

Bases: sip.wrapper

Methods

archiveName	rtype: str
archiveRegistry	rtype: Any
baseDir	rtype: str
clearArchives
copyingFileName	param dirName:
copyingInfo	param fileName:
defaultArchive	rtype: Optional[QgsCptCityArchive]
defaultBaseDir	rtype: str
descFileName	param dirName:
description	param fileName:
findFileName	param target:
initArchive	param archiveName:
initArchives	param loadAll:
initDefaultArchive
isEmpty	rtype: bool
rootItems	rtype: List[QgsCptCityDataItem]
selectionItems	rtype: List[QgsCptCityDataItem]
setBaseDir	param dirName:

archiveName(self) → str

Return type:

str

archiveRegistry() → Any

Return type:

Any

baseDir(self) → str

baseDir(archiveName: str | None) → str

Return type:

str

clearArchives()

copyingFileName(self, dirName: str | None) → str

Parameters:

dirName (Optional[str])

Return type:

str

copyingInfo(fileName: str | None) → Dict[str, str]

Parameters:

fileName (Optional[str])

Return type:

Dict[str, str]

defaultArchive() → QgsCptCityArchive | None

Return type:

Optional[QgsCptCityArchive]

defaultBaseDir() → str

Return type:

str

descFileName(self, dirName: str | None) → str

Parameters:

dirName (Optional[str])

Return type:

str

description(fileName: str | None) → Dict[str, str]

Parameters:

fileName (Optional[str])

Return type:

Dict[str, str]

findFileName(target: str | None, startDir: str | None, baseDir: str | None) → str

Parameters:

• target (Optional[str])

• startDir (Optional[str])

• baseDir (Optional[str])

Return type:

str

initArchive(archiveName: str | None, archiveBaseDir: str | None)

Parameters:

• archiveName (Optional[str])

• archiveBaseDir (Optional[str])

initArchives(loadAll: bool = False)

Parameters:

loadAll (bool = False)

initDefaultArchive()

isEmpty(self) → bool

Return type:

bool

rootItems(self) → List[QgsCptCityDataItem]

Return type:

List[QgsCptCityDataItem]

selectionItems(self) → List[QgsCptCityDataItem]

Return type:

List[QgsCptCityDataItem]

setBaseDir(self, dirName: str | None)

Parameters:

dirName (Optional[str])