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 description 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

param event

swapOptionsUI

tabletEvent

timerEvent

updateControls

updateMicroFocus

updateOptions

updateProfiles

Reloads profiles list from QGIS settings

validateOptions

Validates options correctness

wheelEvent

Signals

optionsChanged

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

Attributes

Default

Full

LineEdit

ProfileLineEdit

Table

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

Bases: int

actionEvent(self, QActionEvent)
apply(self)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createOptions()
currentProfileKey()
customEvent(self, QEvent)
deleteCreateOptions()
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) bool
eventFilter(self, QObject, QEvent) bool
focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) bool
helpOptions(self)

Opens window with options description for given provider and output format

hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
mOptionsAddButton_clicked()
mOptionsDeleteButton_clicked()
mOptionsLineEdit_editingFinished()
mProfileDeleteButton_clicked()
mProfileNewButton_clicked()
mProfileResetButton_clicked()
metric(self, QPaintDevice.PaintDeviceMetric) int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int]
options(self) List[str]

Returns list of selected options

See also

setOptions()

Return type

List[str]

optionsChanged

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.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

optionsTableChanged()
optionsTableEnableDeleteButton()
paintEvent(self, QPaintEvent)
profiles()
pseudoFormat()
receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
setCreateOptions()
setFormat(self, format: str)

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

Parameters

format (str) –

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.

Parameters

options (str) –

setProvider(self, provider: str)

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

Parameters

provider (str) –

setPyramidsFormat(self, format: QgsRaster.RasterPyramidsFormat)

Set pyramids format to use

Parameters

format (QgsRaster.RasterPyramidsFormat) –

setRasterFileName(self, file: str)

Set output raster file name

Parameters

file (str) –

setRasterLayer(self, rasterLayer: QgsRasterLayer)

Set output raster layer

Parameters

rasterLayer (QgsRasterLayer) –

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

Set widget look and feel

Parameters

type (QgsRasterFormatSaveOptionsWidget.Type = QgsRasterFormatSaveOptionsWidget.Default) –

settingsKey()
sharedPainter(self) QPainter
showEvent(self, event: QShowEvent)
Parameters

event (QShowEvent) –

swapOptionsUI()
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateControls()
updateMicroFocus(self)
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

wheelEvent(self, QWheelEvent)