Encapsulates the definition of a GDAL configuration option. More...

#include <qgsgdalutils.h>

Public Types
enum class	Type { Invalid , Select , Boolean , Text , Int , Double }
	Option types. More...

Static Public Member Functions
static QgsGdalOption	fromXmlNode (const CPLXMLNode *node)
	Creates a QgsGdalOption from an XML node.

static QList< QgsGdalOption >	optionsFromXml (const CPLXMLNode *node)
	Returns a list of all GDAL options from an XML node.

Public Attributes
QVariant	defaultValue
	Default value.

QString	description
	Option description.

QVariant	maximum
	Maximum acceptable value.

QVariant	minimum
	Minimum acceptable value.

QString	name
	Option name.

QStringList	options
	Available choices, for Select options.

QString	scope
	Option scope.

Type	type = Type::Invalid
	Option type.

Detailed Description

Encapsulates the definition of a GDAL configuration option.

Note: not available in Python bindings

Since: QGIS 3.40

Definition at line 36 of file qgsgdalutils.h.

Member Enumeration Documentation

◆ Type

enum class QgsGdalOption::Type

strong

Option types.

Enumerator
Invalid	Invalid option.
Select	Selection option.
Boolean	Boolean option.
Text	Text option.
Int	Integer option.
Double	Double option.

Definition at line 43 of file qgsgdalutils.h.

Member Function Documentation

◆ fromXmlNode()

QgsGdalOption QgsGdalOption::fromXmlNode ( const CPLXMLNode * node )

static

Creates a QgsGdalOption from an XML node.

Returns an invalid option if the node could not be interpreted as a GDAL option.

Definition at line 36 of file qgsgdalutils.cpp.

◆ optionsFromXml()

QList< QgsGdalOption > QgsGdalOption::optionsFromXml ( const CPLXMLNode * node )

static

Returns a list of all GDAL options from an XML node.

Definition at line 143 of file qgsgdalutils.cpp.

Member Data Documentation

◆ defaultValue

QVariant QgsGdalOption::defaultValue

Default value.

Definition at line 66 of file qgsgdalutils.h.

◆ description

QString QgsGdalOption::description

Option description.

Definition at line 60 of file qgsgdalutils.h.

◆ maximum

QVariant QgsGdalOption::maximum

Maximum acceptable value.

Definition at line 72 of file qgsgdalutils.h.

◆ minimum

QVariant QgsGdalOption::minimum

Minimum acceptable value.

Definition at line 69 of file qgsgdalutils.h.

◆ name

QString QgsGdalOption::name

Option name.

Definition at line 54 of file qgsgdalutils.h.

◆ options

QStringList QgsGdalOption::options

Available choices, for Select options.

Definition at line 63 of file qgsgdalutils.h.

◆ scope

QString QgsGdalOption::scope

Option scope.

Definition at line 75 of file qgsgdalutils.h.

◆ type

Type QgsGdalOption::type = Type::Invalid

Option type.

Definition at line 57 of file qgsgdalutils.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/qgsgdalutils.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/qgsgdalutils.cpp

Public Types

Static Public Member Functions

Public Attributes