QgsMultiEditToolButton class

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.

Reference

Public types

enum State { Default, MixedValues, Changed }: Button states.

Constructors, destructors, conversion operators

QgsMultiEditToolButton(QWidget* parent = nullptr) explicit: Constructor for QgsMultiEditToolButton.

Public functions

void setField(const QgsField& field): Sets the field associated with this button.
auto state() const -> State: Returns the current displayed state of the button.

Signals

void resetFieldValueTriggered(): Emitted when the "reset to original values" option is selected.
void setFieldValueTriggered(): Emitted when the "set field value for all features" option is selected.

Public slots

void changesCommitted(): Called when field values have been changed and field now contains all the same values.
void resetChanges(): Resets the changed state for the field.
void setIsChanged(bool changed): Sets whether the associated field has changed.
void setIsMixed(bool mixed): Sets whether the associated field contains mixed values.

Enum documentation

enum QgsMultiEditToolButton::State

Button states.

Enumerators
Default	Default state, all features have same value for widget.
MixedValues	Mixed state, some features have different values for the widget.
Changed	Value for widget has changed but changes have not yet been committed.

Function documentation

QgsMultiEditToolButton::QgsMultiEditToolButton(QWidget* parent = nullptr) explicit

Constructor for QgsMultiEditToolButton.

Parameters
parent	parent object

void QgsMultiEditToolButton::setField(const QgsField& field)

Sets the field associated with this button.

Parameters
field	associated field

This is used to customize the widget menu and tooltips to match the field properties.

void QgsMultiEditToolButton::changesCommitted() public slot

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

void QgsMultiEditToolButton::resetChanges() public slot

Resets the changed state for the field.

void QgsMultiEditToolButton::setIsChanged(bool changed) public slot

Sets whether the associated field has changed.

Parameters
changed	whether field has changed

void QgsMultiEditToolButton::setIsMixed(bool mixed) public slot

Sets whether the associated field contains mixed values.

Parameters
mixed	whether field values are mixed