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

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsColorEditorWidgetWrapper:

Public Member Functions
	QgsSettingsColorEditorWidgetWrapper (QObject *parent=nullptr)
	Constructor. More...

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

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. More...

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

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

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

QColor	valueFromWidget () const override
	Returns the widget value. More...

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

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

QgsColorButton *	editor () const
	Returns the editor. More...

virtual QString	id () const override=0
	This id of the type of settings it handles. More...

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

const QgsSettingsEntryColor *	setting () const
	Returns the setting. More...

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

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

virtual bool	setWidgetValue (const QColor &value) const=0
	Sets the widget value. More...

virtual QColor	valueFromWidget () const=0
	Returns the widget value. More...

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

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

virtual	~QgsSettingsEditorWidgetWrapper ()=default

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

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

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

virtual QString	id () const =0
	This id of the type of settings it handles. More...

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

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

virtual void	setWidgetFromVariant (const QVariant &value) const =0
	Sets the value of the widget The wrapper must be configured before calling this medthod. More...

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

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() More...

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

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

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

virtual bool	configureEditorPrivate (QWidget editor, const QgsSettingsEntryBase setting)=0
	Configures an existing editor widget. More...

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

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.

Since: QGIS 3.32

Definition at line 227 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsColorEditorWidgetWrapper()

QgsSettingsColorEditorWidgetWrapper::QgsSettingsColorEditorWidgetWrapper ( QObject * parent = nullptr )

inline

Constructor.

Definition at line 232 of file qgssettingseditorwidgetwrapperimpl.h.

Member Function Documentation

◆ configureEditorPrivateImplementation()

void QgsSettingsColorEditorWidgetWrapper::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 253 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ createWrapper()

QgsSettingsEditorWidgetWrapper * QgsSettingsColorEditorWidgetWrapper::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 235 of file qgssettingseditorwidgetwrapperimpl.h.

◆ id()

QString QgsSettingsColorEditorWidgetWrapper::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 234 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setSettingFromWidget()

bool QgsSettingsColorEditorWidgetWrapper::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 265 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setWidgetValue()

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

overridevirtual

Sets the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 239 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ valueFromWidget()

QColor QgsSettingsColorEditorWidgetWrapper::valueFromWidget ( ) const

overridevirtual

Returns the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryColor, QgsColorButton, QColor >.

Definition at line 279 of file qgssettingseditorwidgetwrapperimpl.cpp.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSettingsColorEditorWidgetWrapper()

Member Function Documentation

◆ configureEditorPrivateImplementation()

◆ createWrapper()

◆ id()

◆ setSettingFromWidget()

◆ setWidgetValue()

◆ valueFromWidget()