Subgroup: Editor

Class: QgsEditorConfigWidget¶

class qgis.gui.QgsEditorConfigWidget¶

Bases: PyQt5.QtWidgets.QWidget, qgis._core.QgsExpressionContextGenerator

This class should be subclassed for every configurable editor widget type.

It implements the GUI configuration widget and transforms this to/from a configuration.

It will only be instantiated by {QgsEditorWidgetFactory}

Methods

acceptDrops

accessibleDescription

accessibleName

actionEvent

actions

activateWindow

addAction

addActions

adjustSize

autoFillBackground

backgroundRole

baseSize

blockSignals

changeEvent

childAt childAt(self, int, int) -> QWidget

childEvent

children

childrenRect

childrenRegion

clearFocus

clearMask

close

closeEvent

colorCount

config Create a configuration from the current GUI state

connectNotify

contentsMargins

contentsRect

contextMenuEvent

contextMenuPolicy

create

createExpressionContext

createWindowContainer

cursor

customEvent

deleteLater

depth

destroy

devType

devicePixelRatio

devicePixelRatioF

devicePixelRatioFScale

disconnect

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

dumpObjectInfo

dumpObjectTree

dynamicPropertyNames

effectiveWinId

ensurePolished

enterEvent

event

eventFilter

field Returns the field for which this configuration widget applies

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

hide

hideEvent

inherits

initPainter

initializeDataDefinedButton Registers a property override button, setting up its initial value, connections and description.

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

layer Returns the layer for which this configuration widget applies

layout

layoutDirection

leaveEvent

locale

logicalDpiX

logicalDpiY

lower

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

overrideWindowFlags

overrideWindowState

paintEngine

paintEvent

paintingActive

palette

parent

parentWidget

physicalDpiX

physicalDpiY

pos

previousInFocusChain

property

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)

setConfig Update the configuration widget to represent the given configuration.

setContentsMargins setContentsMargins(self, QMargins)

setContextMenuPolicy

setCursor

setDisabled

setEnabled

setFixedHeight

setFixedSize setFixedSize(self, int, int)

setFixedWidth

setFocus setFocus(self, Qt.FocusReason)

setFocusPolicy

setFocusProxy

setFont

setForegroundRole

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

setPalette

setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])

setProperty

setShortcutAutoRepeat

setShortcutEnabled

setSizeIncrement setSizeIncrement(self, QSize)

setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)

setStatusTip

setStyle

setStyleSheet

setTabOrder

setTabletTracking

setToolTip

setToolTipDuration

setUpdatesEnabled

setVisible

setWhatsThis

setWindowFilePath

setWindowFlag

setWindowFlags

setWindowIcon

setWindowIconText

setWindowModality

setWindowModified

setWindowOpacity

setWindowRole

setWindowState

setWindowTitle

sharedPainter

show

showEvent

showFullScreen

showMaximized

showMinimized

showNormal

signalsBlocked

size

sizeHint

sizeIncrement

sizePolicy

stackUnder

startTimer

statusTip

style

styleSheet

tabletEvent

testAttribute

thread

timerEvent

toolTip

toolTipDuration

tr

underMouse

ungrabGesture

unsetCursor

unsetLayoutDirection

unsetLocale

update update(self, QRect)

updateDataDefinedButton Updates a specific property override button to reflect the widgets’s current properties.

updateDataDefinedButtons Updates all property override buttons to reflect the widgets’s current properties.

updateGeometry

updateMicroFocus

updatesEnabled

visibleRegion

whatsThis

wheelEvent

width

widthMM

winId

window

windowFilePath

windowFlags

windowHandle

windowIcon

windowIconText

windowModality

windowOpacity

windowRole

windowState

windowTitle

windowType

x

y

Attributes

DrawChildren

DrawWindowBackground

IgnoreMask

PdmDepth

PdmDevicePixelRatio

PdmDevicePixelRatioScaled

PdmDpiX

PdmDpiY

PdmHeight

PdmHeightMM

PdmNumColors

PdmPhysicalDpiX

PdmPhysicalDpiY

PdmWidth

PdmWidthMM

changed Emitted when the configuration of the widget is changed.

customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]

destroyed destroyed(self, QObject = None) [signal]

objectNameChanged objectNameChanged(self, str) [signal]

staticMetaObject

windowIconChanged windowIconChanged(self, QIcon) [signal]

windowIconTextChanged windowIconTextChanged(self, str) [signal]

windowTitleChanged windowTitleChanged(self, str) [signal]

actionEvent()¶

changeEvent()¶

changed¶: Emitted when the configuration of the widget is changed.

New in version 3.0: [signal]

childEvent()¶

closeEvent()¶

config(self) → Dict[str, Any]¶

Create a configuration from the current GUI state

Returns:	A widget configuration

connectNotify()¶

contextMenuEvent()¶

create()¶

createExpressionContext(self) → QgsExpressionContext¶

customEvent()¶

destroy()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

dropEvent()¶

enterEvent()¶

event()¶

field(self) → int¶

Returns the field for which this configuration widget applies

Returns:	The field index

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

initPainter()¶

initializeDataDefinedButton(self, button: QgsPropertyOverrideButton, key: QgsWidgetWrapper.Property)¶

Registers a property override button, setting up its initial value, connections and description.

Parameters:	button – button to register key – corresponding data defined property key

inputMethodEvent()¶

isSignalConnected()¶

keyPressEvent()¶

keyReleaseEvent()¶

layer(self) → QgsVectorLayer¶

Returns the layer for which this configuration widget applies

Returns:	The layer

leaveEvent()¶

metric()¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

paintEvent()¶

receivers()¶

resizeEvent()¶

sender()¶

senderSignalIndex()¶

setConfig(self, config: Dict[str, Any])¶

Update the configuration widget to represent the given configuration.

Parameters:	config – The configuration which should be represented by this widget

sharedPainter()¶

showEvent()¶

tabletEvent()¶

timerEvent()¶

updateDataDefinedButton(self, button: QgsPropertyOverrideButton)¶: Updates a specific property override button to reflect the widgets’s current properties.

updateDataDefinedButtons(self)¶: Updates all property override buttons to reflect the widgets’s current properties.

updateMicroFocus()¶

wheelEvent()¶