Subgroup: Raster

Class: QgsRasterFormatSaveOptionsWidget

class qgis.gui.QgsRasterFormatSaveOptionsWidget

Bases: PyQt5.QtWidgets.QWidget

A widget to select format-specific raster saving options

Methods

actionEvent
apply
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
createOptions
currentProfileKey
customEvent
deleteCreateOptions
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
eventFilter
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
helpOptions Opens window with options desctiption for given provider and output format
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
mOptionsAddButton_clicked
mOptionsDeleteButton_clicked
mOptionsLineEdit_editingFinished
mProfileDeleteButton_clicked
mProfileNewButton_clicked
mProfileResetButton_clicked
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
options Returns list of selected options
optionsTableChanged
optionsTableEnableDeleteButton
paintEvent
profiles
pseudoFormat
receivers
resizeEvent
sender
senderSignalIndex
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
sharedPainter
showEvent
swapOptionsUI
tabletEvent
timerEvent
updateControls
updateMicroFocus
updateOptions
updateProfiles Reloads profiles list from QGIS settings
validateOptions Validates options correctness
wheelEvent

Signals

optionsChanged optionsChanged(self) [signal]

Attributes

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

Bases: int

actionEvent()
apply(self)
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
createOptions()
currentProfileKey()
customEvent()
deleteCreateOptions()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
eventFilter()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
helpOptions(self)

Opens window with options desctiption for given provider and output format

hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
mOptionsAddButton_clicked()
mOptionsDeleteButton_clicked()
mOptionsLineEdit_editingFinished()
mProfileDeleteButton_clicked()
mProfileNewButton_clicked()
mProfileResetButton_clicked()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
options(self) → List[str]

Returns list of selected options

See also

setOptions()

optionsChanged

optionsChanged(self) [signal]

optionsTableChanged()
optionsTableEnableDeleteButton()
paintEvent()
profiles()
pseudoFormat()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setCreateOptions()
setFormat(self, format: str)

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

setOptions(self, options: str)

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

See also

options()

New in version 3.0.

setProvider(self, provider: str)

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

setPyramidsFormat(self, format: QgsRaster.RasterPyramidsFormat)

Set pyramids format to use

setRasterFileName(self, file: str)

Set output raster file name

setRasterLayer(self, rasterLayer: QgsRasterLayer)

Set output raster layer

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

Set widget look and feel

settingsKey()
sharedPainter()
showEvent(self, event: QShowEvent)
swapOptionsUI()
tabletEvent()
timerEvent()
updateControls()
updateMicroFocus()
updateOptions()
updateProfiles(self)

Reloads profiles list from QGIS settings

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

Validates options correctness

wheelEvent()