Class: QgsRasterFormatSaveOptionsWidget

A widget to select format-specific raster saving options

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

apply
createOptions
currentProfileKey
deleteCreateOptions
helpOptions	Opens window with options description for given provider and output format
mOptionsAddButton_clicked
mOptionsDeleteButton_clicked
mOptionsLineEdit_editingFinished
mProfileDeleteButton_clicked
mProfileNewButton_clicked
mProfileResetButton_clicked
options	Returns list of selected options
optionsTableChanged
optionsTableEnableDeleteButton
profiles
pseudoFormat
setCreateOptions
setFormat	Set output raster format, it is used to determine list of available options
setOptions	Populate widget with user-defined options.
setProvider	Set provider key, , it is used to determine list of available options
setPyramidsFormat	Set pyramids format to use
setRasterFileName	Set output raster file name
setRasterLayer	Set output raster layer
setType	Set widget look and feel
settingsKey
swapOptionsUI
updateControls
updateOptions
updateProfiles	Reloads profiles list from QGIS settings
validateOptions	Validates options correctness

Signals

optionsChanged

Emitted when the options configured in the widget are changed.

Attributes

Default
Full
LineEdit
ProfileLineEdit
Table

class qgis.gui.QgsRasterFormatSaveOptionsWidget

Bases: QWidget

Default = 0

Full = 1

LineEdit = 3

ProfileLineEdit = 4

Table = 2

class Type

Bases: int

apply(self)

createOptions()

currentProfileKey()

deleteCreateOptions()

helpOptions(self)

Opens window with options description for given provider and output format

mOptionsAddButton_clicked()

mOptionsDeleteButton_clicked()

mOptionsLineEdit_editingFinished()

mProfileDeleteButton_clicked()

mProfileNewButton_clicked()

mProfileResetButton_clicked()

options(self) → List[str]

Returns list of selected options

See also

setOptions()

Return type:

List[str]

signal optionsChanged

Emitted when the options configured in the widget are changed.

optionsTableChanged()

optionsTableEnableDeleteButton()

profiles()

pseudoFormat()

setCreateOptions()

setFormat(self, format: str | None)

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

Parameters:

format (Optional[str])

setOptions(self, options: str | None)

Populate widget with user-defined options. String should contain key=value pairs separated by spaces, e.g. “TILED=YES TFW=YES”

See also

options()

Parameters:

options (Optional[str])

setProvider(self, provider: str | None)

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

Parameters:

provider (Optional[str])

setPyramidsFormat(self, format: Qgis.RasterPyramidFormat)

Set pyramids format to use

Parameters:

format (Qgis.RasterPyramidFormat)

setRasterFileName(self, file: str | None)

Set output raster file name

Parameters:

file (Optional[str])

setRasterLayer(self, rasterLayer: QgsRasterLayer | None)

Set output raster layer

Parameters:

rasterLayer (Optional[QgsRasterLayer])

setType(self, type: QgsRasterFormatSaveOptionsWidget.Type = QgsRasterFormatSaveOptionsWidget.Default)

Set widget look and feel

Parameters:

type (QgsRasterFormatSaveOptionsWidget.Type = QgsRasterFormatSaveOptionsWidget.Default)

settingsKey()

swapOptionsUI()

updateControls()

updateOptions()

updateProfiles(self)

Reloads profiles list from QGIS settings

validateOptions(self, gui: bool = True, reportOk: bool = True) → str

Validates options correctness

Parameters:

• gui (bool = True)

• reportOk (bool = True)

Return type:

str