Sip updates for source select provider and registry

This commit is contained in:
Alessandro Pasotti 2017-09-04 15:15:20 +02:00
parent 2d073d6faf
commit 50e0a01008
2 changed files with 7 additions and 6 deletions

View File

@ -59,7 +59,7 @@ Text for the menu item entry, it will be visible to the user so make sure it's t
:rtype: int :rtype: int
%End %End
virtual QgsAbstractDataSourceWidget *createDataSourceWidget( QWidget *parent = 0 ) const = 0 /Factory/; virtual QgsAbstractDataSourceWidget *createDataSourceWidget( QWidget *parent = 0, Qt::WindowFlags fl = Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Embedded ) const = 0 /Factory/;
%Docstring %Docstring
Create a new instance of QgsAbstractDataSourceWidget (or null). Create a new instance of QgsAbstractDataSourceWidget (or null).
Caller takes responsibility of deleting created. Caller takes responsibility of deleting created.

View File

@ -43,23 +43,24 @@ Get list of available providers
void addProvider( QgsSourceSelectProvider *provider /Transfer/ ); void addProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring %Docstring
Add a provider implementation. Takes ownership of the object. Add a ``provider`` implementation. Takes ownership of the object.
%End %End
void removeProvider( QgsSourceSelectProvider *provider ); bool removeProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring %Docstring
Remove provider implementation from the list (provider object is deleted) :return: true if the provider was actually removed and deleted
:rtype: bool
%End %End
QgsSourceSelectProvider *providerByName( const QString &name ); QgsSourceSelectProvider *providerByName( const QString &name );
%Docstring %Docstring
Return a provider by name or None if not found Return a provider by ``name`` or None if not found
:rtype: QgsSourceSelectProvider :rtype: QgsSourceSelectProvider
%End %End
QList<QgsSourceSelectProvider *> providersByKey( const QString &providerKey ); QList<QgsSourceSelectProvider *> providersByKey( const QString &providerKey );
%Docstring %Docstring
Return a (possibly empty) list of providers by data provider's key Return a (possibly empty) list of providers by data ``providerkey``
:rtype: list of QgsSourceSelectProvider :rtype: list of QgsSourceSelectProvider
%End %End