QgsRasterFormatSaveOptionsWidget Class Reference

A widget to select format-specific raster saving options. More...

#include <qgsrasterformatsaveoptionswidget.h>

Inheritance diagram for QgsRasterFormatSaveOptionsWidget:

Public Types
enum	Type {   Default , Full , Table , LineEdit ,   ProfileLineEdit }

Public Slots
void	apply ()
void	helpOptions ()
	Opens window with options description for given provider and output format.
void	updateProfiles ()
	Reloads profiles list from QGIS settings.
QString	validateOptions (bool gui=true, bool reportOk=true)
	Validates options correctness.

Signals
void	optionsChanged ()
	Emitted when the options configured in the widget are changed.

Public Member Functions
	QgsRasterFormatSaveOptionsWidget (QWidget *parent SIP_TRANSFERTHIS=nullptr, const QString &format="GTiff", QgsRasterFormatSaveOptionsWidget::Type type=Default, const QString &provider="gdal")
QStringList	options () const
	Returns list of selected options.
void	setFormat (const QString &format)
	Set output raster format, it is used to determine list of available options.
void	setOptions (const QString &options)
	Populate widget with user-defined options.
void	setProvider (const QString &provider)
	Set provider key, , it is used to determine list of available options.
void	setPyramidsFormat (Qgis::RasterPyramidFormat format)
	Set pyramids format to use.
void	setRasterFileName (const QString &file)
	Set output raster file name.
void	setRasterLayer (QgsRasterLayer *rasterLayer)
	Set output raster layer.
void	setType (QgsRasterFormatSaveOptionsWidget::Type type=Default)
	Set widget look and feel.

Protected Member Functions
void	showEvent (QShowEvent *event) override

Detailed Description

A widget to select format-specific raster saving options.

Definition at line 32 of file qgsrasterformatsaveoptionswidget.h.

Member Enumeration Documentation

Type

enum QgsRasterFormatSaveOptionsWidget::Type

Enumerator
Default
Full
Table
LineEdit
ProfileLineEdit

Definition at line 37 of file qgsrasterformatsaveoptionswidget.h.

Constructor & Destructor Documentation

QgsRasterFormatSaveOptionsWidget()

QgsRasterFormatSaveOptionsWidget::QgsRasterFormatSaveOptionsWidget	(	QWidget *parent	SIP_TRANSFERTHIS = nullptr,
		const QString &	format = "GTiff",
		QgsRasterFormatSaveOptionsWidget::Type	type = Default,
		const QString &	provider = "gdal" )

Definition at line 41 of file qgsrasterformatsaveoptionswidget.cpp.

Member Function Documentation

apply

void QgsRasterFormatSaveOptionsWidget::apply ( )

slot

Definition at line 256 of file qgsrasterformatsaveoptionswidget.cpp.

helpOptions

void QgsRasterFormatSaveOptionsWidget::helpOptions ( )

slot

Opens window with options description for given provider and output format.

Definition at line 261 of file qgsrasterformatsaveoptionswidget.cpp.

options()

QStringList QgsRasterFormatSaveOptionsWidget::options

(

)

const

Returns list of selected options.

See also

setOptions()

Definition at line 473 of file qgsrasterformatsaveoptionswidget.cpp.

optionsChanged

void QgsRasterFormatSaveOptionsWidget::optionsChanged ( )

signal

Emitted when the options configured in the widget are changed.

setFormat()

void QgsRasterFormatSaveOptionsWidget::setFormat

(

const QString &

format

)

Set output raster format, it is used to determine list of available options.

Definition at line 111 of file qgsrasterformatsaveoptionswidget.cpp.

setOptions()

void QgsRasterFormatSaveOptionsWidget::setOptions

(

const QString &

options

)

Populate widget with user-defined options.

String should contain key=value pairs separated by spaces, e.g. "TILED=YES TFW=YES"

See also

options()

Definition at line 568 of file qgsrasterformatsaveoptionswidget.cpp.

setProvider()

void QgsRasterFormatSaveOptionsWidget::setProvider

(

const QString &

provider

)

Set provider key, , it is used to determine list of available options.

Definition at line 118 of file qgsrasterformatsaveoptionswidget.cpp.

setPyramidsFormat()

void QgsRasterFormatSaveOptionsWidget::setPyramidsFormat ( Qgis::RasterPyramidFormat format )

inline

Set pyramids format to use.

Definition at line 99 of file qgsrasterformatsaveoptionswidget.h.

setRasterFileName()

void QgsRasterFormatSaveOptionsWidget::setRasterFileName ( const QString & file )

inline

Set output raster file name.

Definition at line 72 of file qgsrasterformatsaveoptionswidget.h.

setRasterLayer()

void QgsRasterFormatSaveOptionsWidget::setRasterLayer ( QgsRasterLayer * rasterLayer )

inline

Set output raster layer.

Definition at line 63 of file qgsrasterformatsaveoptionswidget.h.

setType()

void QgsRasterFormatSaveOptionsWidget::setType

(

QgsRasterFormatSaveOptionsWidget::Type

type = Default

)

Set widget look and feel.

Definition at line 125 of file qgsrasterformatsaveoptionswidget.cpp.

showEvent()

void QgsRasterFormatSaveOptionsWidget::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 560 of file qgsrasterformatsaveoptionswidget.cpp.

updateProfiles

void QgsRasterFormatSaveOptionsWidget::updateProfiles ( )

slot

Reloads profiles list from QGIS settings.

Definition at line 164 of file qgsrasterformatsaveoptionswidget.cpp.

validateOptions

QString QgsRasterFormatSaveOptionsWidget::validateOptions ( bool gui = true, bool reportOk = true )

slot

Validates options correctness.

Definition at line 295 of file qgsrasterformatsaveoptionswidget.cpp.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/qgsrasterformatsaveoptionswidget.h
• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/qgsrasterformatsaveoptionswidget.cpp