This class is a factory of editor for color settings with a color button. More...

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsColorButtonWrapper:

[legend]

Public Member Functions
	QgsSettingsColorButtonWrapper (QObject *parent=nullptr)
	Constructor of the factory.

	QgsSettingsColorButtonWrapper (QWidget editor, const QgsSettingsEntryBase setting, const QStringList &dynamicKeyPartList=QStringList())
	Constructor of the wrapper for a given setting and its widget editor.

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

QgsSettingsEditorWidgetWrapper *	createWrapper (QObject *parent=nullptr) const override
	Creates a new instance of the editor wrapper so it can be configured for a widget and a setting.

void	enableAutomaticUpdatePrivate () override
	Enables automatic update, which causes the setting to be updated immediately when the widget value is changed.

QString	id () const override
	This id of the type of settings it handles.

bool	setSettingFromWidget () const override
	Sets the setting value from the widget value The wrapper must be configured before calling this medthod.

bool	setWidgetValue (const QColor &value) const override
	Sets the widget value.

QColor	valueFromWidget () const override
	Returns the widget value.

Public Member Functions inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >
	QgsSettingsEditorWidgetWrapperTemplate (QObject *parent=nullptr)
	Constructor.

QgsColorButton *	editor () const
	Returns the editor.

const QgsSettingsEntryColor *	setting () const
	Returns the setting.

virtual bool	setWidgetFromSetting () const override
	Sets the widget value from the setting value The wrapper must be configured before calling this medthod.

bool	setWidgetFromVariant (const QVariant &value) const override
	Sets the value of the widget The wrapper must be configured before calling this medthod.

QVariant	variantValueFromWidget () const override
	Returns the value from the widget as a variant The wrapper must be configured before calling this medthod.

Public Member Functions inherited from QgsSettingsEditorWidgetWrapper
	QgsSettingsEditorWidgetWrapper (QObject *parent=nullptr)
	Constructor.

virtual	~QgsSettingsEditorWidgetWrapper ()=default

void	configureAutomaticUpdate (QDialog *dialog=nullptr)
	Configure the settings update behavior when a widget value is changed.

bool	configureEditor (QWidget editor, const QgsSettingsEntryBase setting, const QStringList &dynamicKeyPartList=QStringList())
	Configures the editor according the setting.

QWidget *	createEditor (const QgsSettingsEntryBase setting, const QStringList &dynamicKeyPartList=QStringList(), QWidget parent=nullptr)
	Creates the editor widget for the given setting.

QStringList	dynamicKeyPartList () const
	Returns the dynamic key parts.

Additional Inherited Members
Static Public Member Functions inherited from QgsSettingsEditorWidgetWrapper
static QgsSettingsEditorWidgetWrapper *	fromWidget (const QWidget *widget)
	Creates a wrapper from the definition stored in a widget created by createEditor()

Protected Member Functions inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >
bool	configureEditorPrivate (QWidget editor, const QgsSettingsEntryBase setting) override
	Configures an existing editor widget.

virtual QWidget *	createEditorPrivate (QWidget *parent=nullptr) const override
	Creates the widgets.

Protected Attributes inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >
QgsColorButton *	mEditor

const QgsSettingsEntryColor *	mSetting

Protected Attributes inherited from QgsSettingsEditorWidgetWrapper
QStringList	mDynamicKeyPartList

Detailed Description

This class is a factory of editor for color settings with a color button.

Since: QGIS 3.32

Definition at line 299 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsColorButtonWrapper() [1/2]

QgsSettingsColorButtonWrapper::QgsSettingsColorButtonWrapper ( QObject * parent = nullptr )

inline

Constructor of the factory.

Definition at line 304 of file qgssettingseditorwidgetwrapperimpl.h.

◆ QgsSettingsColorButtonWrapper() [2/2]

QgsSettingsColorButtonWrapper::QgsSettingsColorButtonWrapper	(	QWidget *	editor,
		const QgsSettingsEntryBase *	setting,
		const QStringList &	dynamicKeyPartList = `QStringList()`
	)

inline

Constructor of the wrapper for a given setting and its widget editor.

Definition at line 308 of file qgssettingseditorwidgetwrapperimpl.h.

Member Function Documentation

◆ configureEditorPrivateImplementation()

void QgsSettingsColorButtonWrapper::configureEditorPrivateImplementation ( )

overridevirtual

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

Reimplemented from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 348 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ createWrapper()

QgsSettingsEditorWidgetWrapper * QgsSettingsColorButtonWrapper::createWrapper ( QObject * parent = nullptr ) const

inlineoverridevirtual

Creates a new instance of the editor wrapper so it can be configured for a widget and a setting.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 311 of file qgssettingseditorwidgetwrapperimpl.h.

◆ enableAutomaticUpdatePrivate()

void QgsSettingsColorButtonWrapper::enableAutomaticUpdatePrivate ( )

overridevirtual

Enables automatic update, which causes the setting to be updated immediately when the widget value is changed.

Since: QGIS 3.40

Implements QgsSettingsEditorWidgetWrapper.

Definition at line 360 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ id()

QString QgsSettingsColorButtonWrapper::id ( ) const

overridevirtual

This id of the type of settings it handles.

Note: This mostly correspond to the content of Qgis::SettingsType but it's a string since custom Python implementation are possible.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 329 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setSettingFromWidget()

bool QgsSettingsColorButtonWrapper::setSettingFromWidget ( ) const

overridevirtual

Sets the setting value from the widget value The wrapper must be configured before calling this medthod.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 367 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setWidgetValue()

bool QgsSettingsColorButtonWrapper::setWidgetValue ( const QColor & value ) const

overridevirtual

Sets the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 334 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ valueFromWidget()

QColor QgsSettingsColorButtonWrapper::valueFromWidget ( ) const

overridevirtual

Returns the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 381 of file qgssettingseditorwidgetwrapperimpl.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSettingsColorButtonWrapper() [1/2]

◆ QgsSettingsColorButtonWrapper() [2/2]

Member Function Documentation

◆ configureEditorPrivateImplementation()

◆ createWrapper()

◆ enableAutomaticUpdatePrivate()

◆ id()

◆ setSettingFromWidget()

◆ setWidgetValue()

◆ valueFromWidget()