QgsCptCityArchive Class Reference

Represents a CPT City color scheme. More...

#include <qgscptcityarchive.h>

Public Member Functions
	QgsCptCityArchive (const QgsCptCityArchive &rh)=delete
	QgsCptCityArchive (const QString &archiveName=DEFAULT_CPTCITY_ARCHIVE, const QString &baseDir=QString())
	~QgsCptCityArchive ()
QString	archiveName () const
QString	baseDir () const
QString	copyingFileName (const QString &dirName) const
QString	descFileName (const QString &dirName) const
bool	isEmpty () const
	Returns true if archive is empty.
QgsCptCityArchive &	operator= (const QgsCptCityArchive &rh)=delete
QVector< QgsCptCityDataItem * >	rootItems () const
QVector< QgsCptCityDataItem * >	selectionItems () const
void	setBaseDir (const QString &dirName)

Static Public Member Functions
static QMap< QString, QgsCptCityArchive * >	archiveRegistry ()
static QString	baseDir (QString archiveName)
static void	clearArchives ()
static QMap< QString, QString >	copyingInfo (const QString &fileName)
static QgsCptCityArchive *	defaultArchive ()
static QString	defaultBaseDir ()
static QMap< QString, QString >	description (const QString &fileName)
static QString	findFileName (const QString &target, const QString &startDir, const QString &baseDir)
static QMap< double, QPair< QColor, QColor > >	gradientColorMap (const QString &fileName)
static void	initArchive (const QString &archiveName, const QString &archiveBaseDir)
static void	initArchives (bool loadAll=false)
static void	initDefaultArchive ()

Static Public Attributes
static const QgsSettingsEntryString *	settingsCptCityArchiveName = new QgsSettingsEntryString( u"cptcity-archive-name"_s, QgsSettingsTree::sTreeColors, QStringLiteral( DEFAULT_CPTCITY_ARCHIVE ), u"Name of the CPT-City archive subdirectory used as the default source of color ramps."_s )
static const QgsSettingsEntryString *	settingsCptCityBaseDir = new QgsSettingsEntryString( u"cptcity-base-dir"_s, QgsSettingsTree::sTreeColors, QString(), u"Base directory where CPT-City color ramp archives are stored. If empty, the built-in location is used."_s )

Detailed Description

Represents a CPT City color scheme.

Definition at line 41 of file qgscptcityarchive.h.

Constructor & Destructor Documentation

QgsCptCityArchive() [1/2]

QgsCptCityArchive::QgsCptCityArchive	(	const QString &	archiveName = DEFAULT_CPTCITY_ARCHIVE,
		const QString &	baseDir = QString() )

Definition at line 63 of file qgscptcityarchive.cpp.

~QgsCptCityArchive()

QgsCptCityArchive::~QgsCptCityArchive

(

)

Definition at line 108 of file qgscptcityarchive.cpp.

QgsCptCityArchive() [2/2]

QgsCptCityArchive::QgsCptCityArchive ( const QgsCptCityArchive & rh )

delete

Member Function Documentation

archiveName()

QString QgsCptCityArchive::archiveName ( ) const

inline

Definition at line 72 of file qgscptcityarchive.h.

archiveRegistry()

QMap< QString, QgsCptCityArchive * > QgsCptCityArchive::archiveRegistry ( )

static

Definition at line 58 of file qgscptcityarchive.cpp.

baseDir() [1/2]

QString QgsCptCityArchive::baseDir

(

)

const

Definition at line 120 of file qgscptcityarchive.cpp.

baseDir() [2/2]

QString QgsCptCityArchive::baseDir ( QString archiveName )

static

Definition at line 130 of file qgscptcityarchive.cpp.

clearArchives()

void QgsCptCityArchive::clearArchives ( )

static

Definition at line 509 of file qgscptcityarchive.cpp.

copyingFileName()

QString QgsCptCityArchive::copyingFileName

(

const QString &

dirName

)

const

Definition at line 175 of file qgscptcityarchive.cpp.

copyingInfo()

QgsStringMap QgsCptCityArchive::copyingInfo ( const QString & fileName )

static

Definition at line 185 of file qgscptcityarchive.cpp.

defaultArchive()

QgsCptCityArchive * QgsCptCityArchive::defaultArchive ( )

static

Definition at line 438 of file qgscptcityarchive.cpp.

defaultBaseDir()

QString QgsCptCityArchive::defaultBaseDir ( )

static

Definition at line 141 of file qgscptcityarchive.cpp.

descFileName()

QString QgsCptCityArchive::descFileName

(

const QString &

dirName

)

const

Definition at line 180 of file qgscptcityarchive.cpp.

description()

QgsStringMap QgsCptCityArchive::description ( const QString & fileName )

static

Definition at line 286 of file qgscptcityarchive.cpp.

findFileName()

QString QgsCptCityArchive::findFileName ( const QString & target, const QString & startDir, const QString & baseDir )

static

Definition at line 154 of file qgscptcityarchive.cpp.

gradientColorMap()

QMap< double, QPair< QColor, QColor > > QgsCptCityArchive::gradientColorMap ( const QString & fileName )

static

Note

not available in Python bindings

Definition at line 335 of file qgscptcityarchive.cpp.

initArchive()

void QgsCptCityArchive::initArchive ( const QString & archiveName, const QString & archiveBaseDir )

static

Definition at line 447 of file qgscptcityarchive.cpp.

initArchives()

void QgsCptCityArchive::initArchives ( bool loadAll = false )

static

Definition at line 469 of file qgscptcityarchive.cpp.

initDefaultArchive()

void QgsCptCityArchive::initDefaultArchive ( )

static

Definition at line 456 of file qgscptcityarchive.cpp.

isEmpty()

bool QgsCptCityArchive::isEmpty

(

)

const

Returns true if archive is empty.

Definition at line 432 of file qgscptcityarchive.cpp.

operator=()

QgsCptCityArchive & QgsCptCityArchive::operator= ( const QgsCptCityArchive & rh )

delete

rootItems()

QVector< QgsCptCityDataItem * > QgsCptCityArchive::rootItems ( ) const

inline

Definition at line 81 of file qgscptcityarchive.h.

selectionItems()

QVector< QgsCptCityDataItem * > QgsCptCityArchive::selectionItems ( ) const

inline

Definition at line 82 of file qgscptcityarchive.h.

setBaseDir()

void QgsCptCityArchive::setBaseDir ( const QString & dirName )

inline

Definition at line 58 of file qgscptcityarchive.h.

Member Data Documentation

settingsCptCityArchiveName

const QgsSettingsEntryString * QgsCptCityArchive::settingsCptCityArchiveName = new QgsSettingsEntryString( u"cptcity-archive-name"_s, QgsSettingsTree::sTreeColors, QStringLiteral( DEFAULT_CPTCITY_ARCHIVE ), u"Name of the CPT-City archive subdirectory used as the default source of color ramps."_s )

static

Definition at line 46 of file qgscptcityarchive.h.

settingsCptCityBaseDir

const QgsSettingsEntryString * QgsCptCityArchive::settingsCptCityBaseDir = new QgsSettingsEntryString( u"cptcity-base-dir"_s, QgsSettingsTree::sTreeColors, QString(), u"Base directory where CPT-City color ramp archives are stored. If empty, the built-in location is used."_s )

static

Definition at line 44 of file qgscptcityarchive.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-4.1.0+git20260430+01362494303+99sid/src/core/symbology/qgscptcityarchive.h
• /build/qgis-4.1.0+git20260430+01362494303+99sid/src/core/symbology/qgscptcityarchive.cpp