QgsSettingsBoolCheckBoxWrapper Class Reference

This class is a factory of editor for boolean settings with a checkbox. More...

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsBoolCheckBoxWrapper:

Public Member Functions
	QgsSettingsBoolCheckBoxWrapper (QObject *parent=nullptr)
	Constructor of the factory.
	QgsSettingsBoolCheckBoxWrapper (QWidget *editor, const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList=QStringList())
	Constructor of the wrapper for a given setting and its widget editor.
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 bool &value) const override
	Sets the widget value.
bool	valueFromWidget () const override
	Returns the widget value.
Public Member Functions inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryBool, QCheckBox, bool >
	QgsSettingsEditorWidgetWrapperTemplate (QObject *parent=nullptr)
	Constructor.
QCheckBox *	editor () const
	Returns the editor.
const QgsSettingsEntryBool *	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.
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.
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< QgsSettingsEntryBool, QCheckBox, bool >
bool	configureEditorPrivate (QWidget *editor, const QgsSettingsEntryBase *setting) override
	Configures an existing editor widget.
virtual void	configureEditorPrivateImplementation ()
	To be re-implemented to implemeent type specific configuration (e.g. opacity for colors)
virtual QWidget *	createEditorPrivate (QWidget *parent=nullptr) const override
	Creates the widgets.
Protected Attributes inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryBool, QCheckBox, bool >
QCheckBox *	mEditor
const QgsSettingsEntryBool *	mSetting
Protected Attributes inherited from QgsSettingsEditorWidgetWrapper
QStringList	mDynamicKeyPartList

Detailed Description

This class is a factory of editor for boolean settings with a checkbox.

Since

QGIS 3.32

Definition at line 204 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

QgsSettingsBoolCheckBoxWrapper() [1/2]

QgsSettingsBoolCheckBoxWrapper::QgsSettingsBoolCheckBoxWrapper ( QObject *  parent = nullptr )

inline

Constructor of the factory.

Definition at line 209 of file qgssettingseditorwidgetwrapperimpl.h.

QgsSettingsBoolCheckBoxWrapper() [2/2]

QgsSettingsBoolCheckBoxWrapper::QgsSettingsBoolCheckBoxWrapper ( 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 213 of file qgssettingseditorwidgetwrapperimpl.h.

Member Function Documentation

createWrapper()

QgsSettingsEditorWidgetWrapper * QgsSettingsBoolCheckBoxWrapper::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< QgsSettingsEntryBool, QCheckBox, bool >.

Definition at line 216 of file qgssettingseditorwidgetwrapperimpl.h.

enableAutomaticUpdatePrivate()

void QgsSettingsBoolCheckBoxWrapper::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 176 of file qgssettingseditorwidgetwrapperimpl.cpp.

id()

QString QgsSettingsBoolCheckBoxWrapper::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< QgsSettingsEntryBool, QCheckBox, bool >.

Definition at line 157 of file qgssettingseditorwidgetwrapperimpl.cpp.

setSettingFromWidget()

bool QgsSettingsBoolCheckBoxWrapper::setSettingFromWidget ( ) const

overridevirtual

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

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryBool, QCheckBox, bool >.

Definition at line 184 of file qgssettingseditorwidgetwrapperimpl.cpp.

setWidgetValue()

bool QgsSettingsBoolCheckBoxWrapper::setWidgetValue ( const bool &  value ) const

overridevirtual

Sets the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryBool, QCheckBox, bool >.

Definition at line 162 of file qgssettingseditorwidgetwrapperimpl.cpp.

valueFromWidget()

bool QgsSettingsBoolCheckBoxWrapper::valueFromWidget ( ) const

overridevirtual

Returns the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryBool, QCheckBox, bool >.

Definition at line 198 of file qgssettingseditorwidgetwrapperimpl.cpp.

---

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

• /build/qgis-3.39.0+git20241023+8f1a6e30482+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h
• /build/qgis-3.39.0+git20241023+8f1a6e30482+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp