Class: QgsCptCityArchive¶

Represents a CPT City color scheme.

Methods

`archiveName`
`baseDir`
`copyingFileName`
`descFileName`
`isEmpty`	Returns `True` if archive is empty
`rootItems`
`selectionItems`
`setBaseDir`

Static Methods

`archiveRegistry`
`clearArchives`
`copyingInfo`
`defaultArchive`
`defaultBaseDir`
`description`
`findFileName`
`initArchive`
`initArchives`
`initDefaultArchive`

class qgis.core.QgsCptCityArchive[source]¶

Bases: object

archiveName(self) → str[source]¶

Return type:: str

static archiveRegistry() → Any¶

Return type:: Any

baseDir(self) → str[source]¶

baseDir(archiveName: str | None) → str

Return type:: str

baseDir(archiveName: str | None) → str[source]

Parameters:: archiveName (Optional[str])
Return type:: str

static clearArchives()[source]¶

copyingFileName(self, dirName: str | None) → str[source]¶

Parameters:: dirName (Optional[str])
Return type:: str

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

Parameters:: fileName (Optional[str])
Return type:: Dict[str, str]

static defaultArchive() → QgsCptCityArchive | None[source]¶

Return type:: Optional[QgsCptCityArchive]

static defaultBaseDir() → str[source]¶

Return type:: str

descFileName(self, dirName: str | None) → str[source]¶

Parameters:: dirName (Optional[str])
Return type:: str

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

Parameters:: fileName (Optional[str])
Return type:: Dict[str, str]

static findFileName(target: str | None, startDir: str | None, baseDir: str | None) → str[source]¶

Parameters:

target (Optional[str])
startDir (Optional[str])
baseDir (Optional[str])

Return type:

str

static initArchive(archiveName: str | None, archiveBaseDir: str | None)[source]¶

Parameters:

archiveName (Optional[str])
archiveBaseDir (Optional[str])

static initArchives(loadAll: bool = False)[source]¶

Parameters:: loadAll (bool = False)

static initDefaultArchive()[source]¶

isEmpty(self) → bool[source]¶

Returns True if archive is empty

Return type:: bool

rootItems(self) → List[QgsCptCityDataItem]¶

Return type:: List[QgsCptCityDataItem]

selectionItems(self) → List[QgsCptCityDataItem]¶

Return type:: List[QgsCptCityDataItem]

setBaseDir(self, dirName: str | None)[source]¶

Parameters:: dirName (Optional[str])