Subgroup: Multi

Class: QgsMultiEditToolButton¶

class qgis.gui.QgsMultiEditToolButton¶

Bases: PyQt5.QtWidgets.QToolButton

A tool button widget which is displayed next to editor widgets in attribute forms, and allows for controlling how the widget behaves and interacts with the form while in multi edit mode.

New in version 2.16: Methods

`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`adjustSize`
`animateClick`
`arrowType`
`autoExclusive`
`autoFillBackground`
`autoRaise`
`autoRepeat`
`autoRepeatDelay`
`autoRepeatInterval`
`backgroundRole`
`baseSize`
`blockSignals`
`changeEvent`
`changesCommitted`	Called when field values have been changed and field now contains all the same values.
`checkStateSet`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clearFocus`
`clearMask`
`click`
`close`
`closeEvent`
`colorCount`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`create`
`createWindowContainer`
`cursor`
`customEvent`
`defaultAction`
`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`
`group`
`hasFocus`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideEvent`
`hitButton`
`icon`
`iconSize`
`inherits`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`insertAction`
`insertActions`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isCheckable`
`isChecked`
`isDown`
`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`
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maximumHeight`
`maximumSize`
`maximumWidth`
`menu`
`metaObject`
`metric`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextCheckState`
`nextInFocusChain`
`normalGeometry`
`objectName`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`physicalDpiX`
`physicalDpiY`
`popupMode`
`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)
`resetChanges`	Resets the changed state for the field.
`resize`	resize(self, int, int)
`resizeEvent`
`restoreGeometry`
`saveGeometry`
`scroll`	scroll(self, int, int, QRect)
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setArrowType`
`setAttribute`
`setAutoExclusive`
`setAutoFillBackground`
`setAutoRaise`
`setAutoRepeat`
`setAutoRepeatDelay`
`setAutoRepeatInterval`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setCheckable`
`setChecked`
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCursor`
`setDefaultAction`
`setDisabled`
`setDown`
`setEnabled`
`setField`	Sets the field associated with this button.
`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`
`setIcon`
`setIconSize`
`setInputMethodHints`
`setIsChanged`	Sets whether the associated field has changed.
`setIsMixed`	Sets whether the associated field contains mixed values.
`setLayout`
`setLayoutDirection`
`setLocale`
`setMask`	setMask(self, QRegion)
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMenu`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setPopupMode`
`setProperty`
`setShortcut`
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabOrder`
`setTabletTracking`
`setText`
`setToolButtonStyle`
`setToolTip`
`setToolTipDuration`
`setUpdatesEnabled`
`setVisible`
`setWhatsThis`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`sharedPainter`
`shortcut`
`show`
`showEvent`
`showFullScreen`
`showMaximized`
`showMenu`
`showMinimized`
`showNormal`
`signalsBlocked`
`size`
`sizeHint`
`sizeIncrement`
`sizePolicy`
`stackUnder`
`startTimer`
`state`	Returns the current displayed state of the button.
`statusTip`
`style`
`styleSheet`
`tabletEvent`
`testAttribute`
`text`
`thread`
`timerEvent`
`toggle`
`toolButtonStyle`
`toolTip`
`toolTipDuration`
`tr`
`underMouse`
`ungrabGesture`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QRect)
`updateGeometry`
`updateMicroFocus`
`updatesEnabled`
`visibleRegion`
`whatsThis`
`wheelEvent`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`x`
`y`

Attributes

`Changed`
`Default`
`DelayedPopup`
`DrawChildren`
`DrawWindowBackground`
`IgnoreMask`
`InstantPopup`
`MenuButtonPopup`
`MixedValues`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`clicked`	clicked(self, bool = False) [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`pressed`	pressed(self) [signal]
`released`	released(self) [signal]
`resetFieldValueTriggered`	Emitted when the “reset to original values” option is selected.
`setFieldValueTriggered`	Emitted when the “set field value for all features” option is selected.
`staticMetaObject`
`toggled`	toggled(self, bool) [signal]
`triggered`	triggered(self, QAction) [signal]
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [signal]

Changed = 2¶

Default = 0¶

MixedValues = 1¶

class State¶: Bases: int

actionEvent()¶

changeEvent()¶

changesCommitted(self)¶: Called when field values have been changed and field now contains all the same values.

See also

resetChanges()

checkStateSet()¶

childEvent()¶

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

create()¶

customEvent()¶

destroy()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

dropEvent()¶

enterEvent()¶

event()¶

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

hitButton()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

isSignalConnected()¶

keyPressEvent()¶

keyReleaseEvent()¶

leaveEvent()¶

metric()¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

nextCheckState()¶

paintEvent()¶

receivers()¶

resetChanges(self)¶: Resets the changed state for the field.

See also

setIsMixed()

See also

setIsChanged()

See also

changesCommitted()

resetFieldValueTriggered¶: Emitted when the “reset to original values” option is selected. [signal]

resizeEvent()¶

sender()¶

senderSignalIndex()¶

setField(self, field: QgsField)¶

Sets the field associated with this button. This is used to customise the widget menu and tooltips to match the field properties.

Parameters:	field – associated field

setFieldValueTriggered¶: Emitted when the “set field value for all features” option is selected. [signal]

setIsChanged(self, changed: bool)¶

Sets whether the associated field has changed.

Parameters:	changed – whether field has changed

See also

isChanged()

See also

setIsMixed()

See also

resetChanges()

setIsMixed(self, mixed: bool)¶

Sets whether the associated field contains mixed values.

Parameters:	mixed – whether field values are mixed

See also

isMixed()

See also

setIsChanged()

See also

resetChanges()

sharedPainter()¶

showEvent()¶

state(self) → QgsMultiEditToolButton.State¶: Returns the current displayed state of the button.

tabletEvent()¶

timerEvent()¶

updateMicroFocus()¶

wheelEvent()¶