Class: QgsMultiEditToolButton

class qgis.gui.QgsMultiEditToolButton(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QToolButton

Constructor for QgsMultiEditToolButton.

Parameters

parent (QWidget = None) – parent object

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.

Methods

actionEvent

changeEvent

changesCommitted

Called when field values have been changed and field now contains all the same values.

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

Resets the changed state for the field.

resizeEvent

sender

senderSignalIndex

setField

Sets the field associated with this button.

setIsChanged

Sets whether the associated field has changed.

setIsMixed

Sets whether the associated field contains mixed values.

sharedPainter

showEvent

state

Returns the current displayed state of the button.

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

resetFieldValueTriggered

Emitted when the “reset to original values” option is selected.

setFieldValueTriggered

Emitted when the “set field value for all features” option is selected.

Attributes

Changed

Default

MixedValues

Changed = 2
Default = 0
MixedValues = 1
class State

Bases: int

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
changesCommitted(self)

Called when field values have been changed and field now contains all the same values.

See also

resetChanges()

checkStateSet(self)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
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
focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) → bool
hideEvent(self, QHideEvent)
hitButton(self, QPoint) → bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionToolButton)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
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], sip.voidptr) → Tuple[bool, int]
nextCheckState(self)
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) → int
resetChanges(self)

Resets the changed state for the field.

See also

setIsMixed()

See also

setIsChanged()

resetFieldValueTriggered

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

resizeEvent(self, QResizeEvent)
sender(self) → QObject
senderSignalIndex(self) → int
setField(self, field: QgsField)

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

Parameters

field (QgsField) – 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 (bool) – whether field has changed

See also

setIsMixed()

See also

resetChanges()

setIsMixed(self, mixed: bool)

Sets whether the associated field contains mixed values.

Parameters

mixed (bool) – whether field values are mixed

See also

setIsChanged()

See also

resetChanges()

sharedPainter(self) → QPainter
showEvent(self, QShowEvent)
state(self)QgsMultiEditToolButton.State

Returns the current displayed state of the button.

Return type

QgsMultiEditToolButton.State

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)