Class: QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryColorQgsColorButtonQColorBase

Base factory for editors for settings.

Added in version 3.32.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: QgsSettingsEditorWidgetWrapper.configureEditorPrivate(), QgsSettingsEditorWidgetWrapper.createEditorPrivate(), QgsSettingsEditorWidgetWrapper.createWrapper(), QgsSettingsEditorWidgetWrapper.enableAutomaticUpdatePrivate(), QgsSettingsEditorWidgetWrapper.id(), QgsSettingsEditorWidgetWrapper.setSettingFromWidget(), QgsSettingsEditorWidgetWrapper.setWidgetFromSetting(), QgsSettingsEditorWidgetWrapper.setWidgetFromVariant(), QgsSettingsEditorWidgetWrapper.variantValueFromWidget()

Class Hierarchy

Base classes

QgsSettingsEditorWidgetWrapper	Base class for settings editor wrappers.
QObject

Subclasses

QgsSettingsColorButtonWrapper

A factory for editors of color settings with a color button.

Methods

configureEditorPrivateImplementation	To be re-implemented to implemeent type specific configuration (e.g. opacity for colors).
editor	Returns the editor
setWidgetValue	Sets the widget value
setting	Returns the setting
valueFromWidget	Returns the widget value

class qgis.gui.QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryColorQgsColorButtonQColorBase

Bases: QgsSettingsEditorWidgetWrapper

__init__(parent: QObject | None = None)

Constructor

Parameters:

parent (Optional[QObject] = None)

configureEditorPrivateImplementation(self)

To be re-implemented to implemeent type specific configuration (e.g. opacity for colors)

editor(self) → QgsColorButton | None

Returns the editor

Return type:

Optional[QgsColorButton]

setWidgetValue(self, value: QColor | Qt.GlobalColor) → bool

Sets the widget value

Parameters:

value (Union[QColor, Qt.GlobalColor])

Return type:

bool

setting(self) → QgsSettingsEntryColor | None

Returns the setting

Return type:

Optional[QgsSettingsEntryColor]

valueFromWidget(self) → QColor

Returns the widget value

Return type:

QColor