Class: QgsMultiEditToolButton

A tool button for controlling how edits to multiple features are applied.

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

Class Hierarchy

Inheritance diagram of qgis.gui.QgsMultiEditToolButton

Base classes

QToolButton

QAbstractButton

QWidget

QObject

QPaintDevice

class qgis.gui.QgsMultiEditToolButton[source]

Bases: QToolButton

__init__(parent: QWidget | None = None)

Constructor for QgsMultiEditToolButton.

Parameters:

parent (Optional[QWidget] = None) – parent object

Changed = 2
Default = 0
MixedValues = 1
class State

Bases: int

changesCommitted(self)[source]

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

See also

resetChanges()

resetChanges(self)[source]

Resets the changed state for the field.

See also

setIsMixed()

See also

setIsChanged()

signal resetFieldValueTriggered[source]

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.

setField(self, field: QgsField)[source]

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

signal setFieldValueTriggered[source]

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.

setIsChanged(self, changed: bool)[source]

Sets whether the associated field has changed.

Parameters:

changed (bool) – whether field has changed

See also

setIsMixed()

See also

resetChanges()

setIsMixed(self, mixed: bool)[source]

Sets whether the associated field contains mixed values.

Parameters:

mixed (bool) – whether field values are mixed

See also

setIsChanged()

See also

resetChanges()

state(self) QgsMultiEditToolButton.State[source]

Returns the current displayed state of the button.

Return type:

QgsMultiEditToolButton.State