QGIS API Documentation 3.39.0-Master (699c004a5df)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsSettingsColorEditorWidgetWrapper Class Reference

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

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsColorEditorWidgetWrapper:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsColorEditorWidgetWrapper (QObject *parent=nullptr)
 Constructor.
 
void configureEditorPrivateImplementation () override
 To be re-implemented to implemeent type specific configuration (e.g. opacity for colors)
 
QgsSettingsEditorWidgetWrappercreateWrapper (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.
 
QgsColorButtoneditor () const
 Returns the editor.
 
const QgsSettingsEntryColorsetting () 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.
 
void 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsSettingsEditorWidgetWrapper
static QgsSettingsEditorWidgetWrapperfromWidget (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 >
QgsColorButtonmEditor
 
const QgsSettingsEntryColormSetting
 
- 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 235 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsColorEditorWidgetWrapper()

QgsSettingsColorEditorWidgetWrapper::QgsSettingsColorEditorWidgetWrapper ( QObject *  parent = nullptr)
inline

Constructor.

Definition at line 240 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 285 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 243 of file qgssettingseditorwidgetwrapperimpl.h.

◆ enableAutomaticUpdatePrivate()

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

◆ 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 266 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 305 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setWidgetValue()

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

◆ valueFromWidget()

QColor QgsSettingsColorEditorWidgetWrapper::valueFromWidget ( ) const
overridevirtual

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