Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
sipify
  • Loading branch information
3nids committed Apr 27, 2023
1 parent 0b8ef93 commit feb9b44
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
Expand Up @@ -13,7 +13,7 @@
class QgsSettingsEditorWidgetRegistry
{
%Docstring(signature="appended")
This class manages editors for settings
This class manages editor widgets for settings

.. versionadded:: 3.32
%End
Expand All @@ -30,18 +30,18 @@ Constructor

bool addWrapper( QgsSettingsEditorWidgetWrapper *wrapper /Transfer/ );
%Docstring
Adds a editor to the registry
Returns ``False`` if a editor with same id already exists.
Adds an editor widget ``wrapper`` to the registry
Returns ``False`` if an editor widget with same id already exists.
%End

QgsSettingsEditorWidgetWrapper *createWrapper( const QString &id, QObject *parent ) const;
%Docstring
Returns a new instance of the editor for the given id
Returns a new instance of the editor widget for the given ``id``
%End

QWidget *createEditor( const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList, QWidget *parent = 0 ) const /Factory/;
%Docstring
Creates the editor for the given settings using the corresponding registered wrapper
Creates an editor widget for the given ``setting`` using the corresponding registered wrapper
%End

QMap<QString, QString> editorNames() const;
Expand Down
Expand Up @@ -24,7 +24,7 @@ Base class for settings editor wrappers
public:
static QgsSettingsEditorWidgetWrapper *fromWidget( const QWidget *widget ) /Factory/;
%Docstring
Creates a wrapper from the definition stored in a widget created by :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor`
Creates a wrapper from the definition stored in a ``widget`` created by :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor`
%End

QgsSettingsEditorWidgetWrapper( QObject *parent = 0 );
Expand All @@ -50,7 +50,7 @@ Creates a new instance of the editor wrapper so it can be configured for a widge

QWidget *createEditor( const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList = QStringList(), QWidget *parent = 0 );
%Docstring
Creates the editor for the given widget
Creates the editor widget for the given ``setting``
%End

bool configureEditor( QWidget *editor, const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList = QStringList() );
Expand All @@ -66,7 +66,7 @@ The wrapper must be configured before calling this medthod

virtual bool setSettingFromWidget() const = 0;
%Docstring
SDets the setting value from the widget value
Sets the setting value from the widget value
The wrapper must be configured before calling this medthod
%End

Expand All @@ -78,7 +78,7 @@ The wrapper must be configured before calling this medthod

virtual void setWidgetFromVariant( const QVariant &value ) const = 0;
%Docstring
Sets the value of the widget
Sets the ``value`` of the widget
The wrapper must be configured before calling this medthod
%End

Expand All @@ -91,7 +91,7 @@ Creates the widgets

virtual bool configureEditorPrivate( QWidget *editor, const QgsSettingsEntryBase *setting ) = 0;
%Docstring
Configures an existing widget
Configures an existing ``editor`` widget
%End

};
Expand Down

0 comments on commit feb9b44

Please sign in to comment.