QgsSettingsStringEditorWidgetWrapper Class Reference

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

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsStringEditorWidgetWrapper:

Public Member Functions
	QgsSettingsStringEditorWidgetWrapper (QObject *parent=nullptr)
	Constructor.
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.
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 QString &value) const override
	Sets the widget value.
QString	valueFromWidget () const override
	Returns the widget value.
Public Member Functions inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryString, QLineEdit, QString >
	QgsSettingsEditorWidgetWrapperTemplate (QObject *parent=nullptr)
	Constructor.
QLineEdit *	editor () const
	Returns the editor.
const QgsSettingsEntryString *	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
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 QgsSettingsEditorWidgetWrapper *	fromWidget (const QWidget *widget)
	Creates a wrapper from the definition stored in a widget created by createEditor()
Protected Member Functions inherited from QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryString, QLineEdit, QString >
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< QgsSettingsEntryString, QLineEdit, QString >
QLineEdit *	mEditor
const QgsSettingsEntryString *	mSetting
Protected Attributes inherited from QgsSettingsEditorWidgetWrapper
QStringList	mDynamicKeyPartList

Detailed Description

This class is a factory of editor for string settings.

Since

QGIS 3.32

Definition at line 125 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

QgsSettingsStringEditorWidgetWrapper()

QgsSettingsStringEditorWidgetWrapper::QgsSettingsStringEditorWidgetWrapper ( QObject *  parent = nullptr )

inline

Constructor.

Definition at line 130 of file qgssettingseditorwidgetwrapperimpl.h.

Member Function Documentation

createWrapper()

QgsSettingsEditorWidgetWrapper * QgsSettingsStringEditorWidgetWrapper::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< QgsSettingsEntryString, QLineEdit, QString >.

Definition at line 133 of file qgssettingseditorwidgetwrapperimpl.h.

id()

QString QgsSettingsStringEditorWidgetWrapper::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< QgsSettingsEntryString, QLineEdit, QString >.

Definition at line 30 of file qgssettingseditorwidgetwrapperimpl.cpp.

setSettingFromWidget()

bool QgsSettingsStringEditorWidgetWrapper::setSettingFromWidget ( ) const

overridevirtual

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

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryString, QLineEdit, QString >.

Definition at line 49 of file qgssettingseditorwidgetwrapperimpl.cpp.

setWidgetValue()

bool QgsSettingsStringEditorWidgetWrapper::setWidgetValue ( const QString &  value ) const

overridevirtual

Sets the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryString, QLineEdit, QString >.

Definition at line 35 of file qgssettingseditorwidgetwrapperimpl.cpp.

valueFromWidget()

QString QgsSettingsStringEditorWidgetWrapper::valueFromWidget ( ) const

overridevirtual

Returns the widget value.

Implements QgsSettingsEditorWidgetWrapperTemplate< QgsSettingsEntryString, QLineEdit, QString >.

Definition at line 63 of file qgssettingseditorwidgetwrapperimpl.cpp.

---

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

• /build/qgis-3.39.0+git20240703+47f7b3a4989+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h
• /build/qgis-3.39.0+git20240703+47f7b3a4989+99sid/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp