Class: QgsRasterFormatSaveOptionsWidget

A widget to select format-specific raster saving options.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsRasterFormatSaveOptionsWidget

Base classes

QWidget

QObject

QPaintDevice

class qgis.gui.QgsRasterFormatSaveOptionsWidget[source]

Bases: QWidget

Default = 0
Full = 1
LineEdit = 3
ProfileLineEdit = 4
Table = 2
class Type

Bases: int

apply(self)[source]
creationOptions()[source]
currentProfileKey()[source]
deleteCreationOptions()[source]
helpOptions(self)[source]

Opens window with options description for given provider and output format

mOptionsAddButton_clicked()[source]
mOptionsDeleteButton_clicked()[source]
mOptionsLineEdit_editingFinished()[source]
mProfileDeleteButton_clicked()[source]
mProfileNewButton_clicked()[source]
mProfileResetButton_clicked()[source]
options(self) List[str][source]

Returns list of selected options

See also

setOptions()

Return type:

List[str]

signal optionsChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

optionsTableChanged()[source]
optionsTableEnableDeleteButton()[source]
profiles()[source]
pseudoFormat()[source]
setCreationOptions()[source]
setFormat(self, format: str | None)[source]

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

Parameters:

format (Optional[str])

setOptions(self, options: str | None)[source]

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)[source]

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

Parameters:

provider (Optional[str])

setPyramidsFormat(self, format: Qgis.RasterPyramidFormat)[source]

Set pyramids format to use

Parameters:

format (Qgis.RasterPyramidFormat)

setRasterFileName(self, file: str | None)[source]

Set output raster file name

Parameters:

file (Optional[str])

setRasterLayer(self, rasterLayer: QgsRasterLayer | None)[source]

Set output raster layer

Parameters:

rasterLayer (Optional[QgsRasterLayer])

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

Set widget look and feel

Parameters:

type (QgsRasterFormatSaveOptionsWidget.Type = QgsRasterFormatSaveOptionsWidget.Default)

settingsKey()[source]
swapOptionsUI()[source]
updateControls()[source]
updateOptions()[source]
updateProfiles(self)[source]

Reloads profiles list from QGIS settings

validateOptions(self, gui: bool = True, reportOk: bool = True) str[source]

Validates options correctness

Parameters:
  • gui (bool = True)

  • reportOk (bool = True)

Return type:

str