Subgroup: Raster

Class: QgsRasterFormatSaveOptionsWidget

class qgis.gui.QgsRasterFormatSaveOptionsWidget

Bases: PyQt5.QtWidgets.QWidget

A widget to select format-specific raster saving options

Methods

acceptDrops
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
adjustSize
apply
autoFillBackground
backgroundRole
baseSize
blockSignals
changeEvent
childAt childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
close
closeEvent
colorCount
connectNotify
contentsMargins
contentsRect
contextMenuEvent
contextMenuPolicy
create
createOptions
createWindowContainer
currentProfileKey
cursor
customEvent
deleteCreateOptions
deleteLater
depth
destroy
devType
devicePixelRatio
devicePixelRatioF
devicePixelRatioFScale
disconnect
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
effectiveWinId
ensurePolished
enterEvent
event
eventFilter
find
findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPolicy
focusPreviousChild
focusProxy
focusWidget
font
fontInfo
fontMetrics
foregroundRole
frameGeometry
frameSize
geometry
getContentsMargins
grab
grabGesture
grabKeyboard
grabMouse grabMouse(self, Union[QCursor, Qt.CursorShape])
grabShortcut
graphicsEffect
graphicsProxyWidget
hasFocus
hasHeightForWidth
hasMouseTracking
hasTabletTracking
height
heightForWidth
heightMM
helpOptions Opens window with options desctiption for given provider
hide
hideEvent
inherits
initPainter
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isEnabled
isEnabledTo
isFullScreen
isHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isSignalConnected
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
keyPressEvent
keyReleaseEvent
keyboardGrabber
killTimer
layout
layoutDirection
leaveEvent
locale
logicalDpiX
logicalDpiY
lower
mOptionsAddButton_clicked
mOptionsDeleteButton_clicked
mOptionsLineEdit_editingFinished
mProfileDeleteButton_clicked
mProfileNewButton_clicked
mProfileResetButton_clicked
mapFrom
mapFromGlobal
mapFromParent
mapTo
mapToGlobal
mapToParent
mask
maximumHeight
maximumSize
maximumWidth
metaObject
metric
minimumHeight
minimumSize
minimumSizeHint
minimumWidth
mouseDoubleClickEvent
mouseGrabber
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
move move(self, int, int)
moveEvent
moveToThread
nativeEvent
nativeParentWidget
nextInFocusChain
normalGeometry
objectName
options Returns list of selected options
optionsTableChanged
optionsTableEnableDeleteButton
overrideWindowFlags
overrideWindowState
paintEngine
paintEvent
paintingActive
palette
parent
parentWidget
physicalDpiX
physicalDpiY
pos
previousInFocusChain
profiles
property
pseudoFormat
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
raise_
receivers
rect
releaseKeyboard
releaseMouse
releaseShortcut
removeAction
removeEventFilter
render render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))
repaint repaint(self, int, int, int, int)
resize resize(self, int, int)
resizeEvent
restoreGeometry
saveGeometry
scroll scroll(self, int, int, QRect)
sender
senderSignalIndex
setAcceptDrops
setAccessibleDescription
setAccessibleName
setAttribute
setAutoFillBackground
setBackgroundRole
setBaseSize setBaseSize(self, QSize)
setContentsMargins setContentsMargins(self, QMargins)
setContextMenuPolicy
setCreateOptions
setCursor
setDisabled
setEnabled
setFixedHeight
setFixedSize setFixedSize(self, int, int)
setFixedWidth
setFocus setFocus(self, Qt.FocusReason)
setFocusPolicy
setFocusProxy
setFont
setForegroundRole
setFormat Set output raster format, it is used to determine list
setGeometry setGeometry(self, int, int, int, int)
setGraphicsEffect
setHidden
setInputMethodHints
setLayout
setLayoutDirection
setLocale
setMask setMask(self, QRegion)
setMaximumHeight
setMaximumSize setMaximumSize(self, QSize)
setMaximumWidth
setMinimumHeight
setMinimumSize setMinimumSize(self, QSize)
setMinimumWidth
setMouseTracking
setObjectName
setOptions Populate widget with user-defined options.
setPalette
setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
setProperty
setProvider Set provider key, , it is used to determine list
setPyramidsFormat Set pyramids format to use
setRasterFileName Set output raster file name
setRasterLayer Set output raster layer
setShortcutAutoRepeat
setShortcutEnabled
setSizeIncrement setSizeIncrement(self, QSize)
setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
setStatusTip
setStyle
setStyleSheet
setTabOrder
setTabletTracking
setToolTip
setToolTipDuration
setType Set widget look and feel
setUpdatesEnabled
setVisible
setWhatsThis
setWindowFilePath
setWindowFlag
setWindowFlags
setWindowIcon
setWindowIconText
setWindowModality
setWindowModified
setWindowOpacity
setWindowRole
setWindowState
setWindowTitle
settingsKey
sharedPainter
show
showEvent
showFullScreen
showMaximized
showMinimized
showNormal
signalsBlocked
size
sizeHint
sizeIncrement
sizePolicy
stackUnder
startTimer
statusTip
style
styleSheet
swapOptionsUI
tabletEvent
testAttribute
thread
timerEvent
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
unsetCursor
unsetLayoutDirection
unsetLocale
update update(self, QRect)
updateControls
updateGeometry
updateMicroFocus
updateOptions
updateProfiles Reloads profiles list from QGIS settings
updatesEnabled
validateOptions Validates options correctness
visibleRegion
whatsThis
wheelEvent
width
widthMM
winId
window
windowFilePath
windowFlags
windowHandle
windowIcon
windowIconText
windowModality
windowOpacity
windowRole
windowState
windowTitle
windowType
x
y

Attributes

Default
DrawChildren
DrawWindowBackground
Full
IgnoreMask
LineEdit
PdmDepth
PdmDevicePixelRatio
PdmDevicePixelRatioScaled
PdmDpiX
PdmDpiY
PdmHeight
PdmHeightMM
PdmNumColors
PdmPhysicalDpiX
PdmPhysicalDpiY
PdmWidth
PdmWidthMM
ProfileLineEdit
Table
customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]
destroyed destroyed(self, QObject = None) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
optionsChanged optionsChanged(self) [signal]
staticMetaObject
windowIconChanged windowIconChanged(self, QIcon) [signal]
windowIconTextChanged windowIconTextChanged(self, str) [signal]
windowTitleChanged windowTitleChanged(self, str) [signal]
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()