QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsSettingsStringLineEditWrapper Class Reference

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

#include <qgssettingseditorwidgetwrapperimpl.h>

Inheritance diagram for QgsSettingsStringLineEditWrapper:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsStringLineEditWrapper (QObject *parent=nullptr)
 Constructor of the factory.
 
 QgsSettingsStringLineEditWrapper (QWidget *editor, const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList=QStringList())
 Constructor of the wrapper for a given setting and its widget editor.
 
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 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 QgsSettingsEntryStringsetting () 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 QgsSettingsEditorWidgetWrapperfromWidget (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 QgsSettingsEntryStringmSetting
 
- Protected Attributes inherited from QgsSettingsEditorWidgetWrapper
QStringList mDynamicKeyPartList
 

Detailed Description

This class is a factory of editor for string settings with a line edit.

Since
QGIS 3.32

Definition at line 125 of file qgssettingseditorwidgetwrapperimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsStringLineEditWrapper() [1/2]

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

Constructor of the factory.

Definition at line 130 of file qgssettingseditorwidgetwrapperimpl.h.

◆ QgsSettingsStringLineEditWrapper() [2/2]

QgsSettingsStringLineEditWrapper::QgsSettingsStringLineEditWrapper ( 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 134 of file qgssettingseditorwidgetwrapperimpl.h.

Member Function Documentation

◆ createWrapper()

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

◆ enableAutomaticUpdatePrivate()

void QgsSettingsStringLineEditWrapper::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 49 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ id()

QString QgsSettingsStringLineEditWrapper::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 QgsSettingsStringLineEditWrapper::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 57 of file qgssettingseditorwidgetwrapperimpl.cpp.

◆ setWidgetValue()

bool QgsSettingsStringLineEditWrapper::setWidgetValue ( const QString &  value) const
overridevirtual

◆ valueFromWidget()

QString QgsSettingsStringLineEditWrapper::valueFromWidget ( ) const
overridevirtual

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