File: qgsproviderguiregistry.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (131 lines) | stat: -rw-r--r-- 4,054 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsproviderguiregistry.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsProviderGuiRegistry
{
%Docstring(signature="appended")
A registry / canonical manager of GUI parts of data providers.

:py:class:`QgsProviderGuiRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsGui.providerGuiRegistry()`.

:py:func:`~setPluginPath` should be called (once) to load dynamic
providers. Static providers are loaded in constructor.

.. versionadded:: 3.10
%End

%TypeHeaderCode
#include "qgsproviderguiregistry.h"
%End
  public:
    QgsProviderGuiRegistry( const QString &pluginPath );
%Docstring
Creates registry and loads static provider plugins
%End

    virtual ~QgsProviderGuiRegistry();

    QStringList providerList() const;
%Docstring
Returns list of available providers by their keys
%End

    const QgsProviderGuiMetadata *providerMetadata( const QString &providerKey ) const;
%Docstring
Returns metadata of the provider or ``None`` if not found
%End

    void registerGuis( QMainWindow *widget );
%Docstring
Called during GUI initialization - allows providers to do its internal
initialization of GUI components, possibly making use of the passed
pointer to the QGIS main window.
%End

    virtual const QList<QgsDataItemGuiProvider *> dataItemGuiProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all data item gui providers registered in provider with
``providerKey``

.. note::

   Ownership of created data item providers is passed to the caller.
%End

    virtual QList<QgsSourceSelectProvider *> sourceSelectProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all source select providers registered in provider with
``providerKey``

.. note::

   Ownership of created source select providers is passed to the caller.
%End

    virtual QList<QgsProjectStorageGuiProvider *> projectStorageGuiProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all project storage gui providers registered in provider with
``providerKey``

.. note::

   Ownership of created project storage gui providers is passed to the caller.
%End

    virtual QList<QgsSubsetStringEditorProvider *> subsetStringEditorProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all subset string editor providers registered in provider with
``providerKey``

.. note::

   Ownership of providers is passed to the caller.

.. versionadded:: 3.18
%End

    virtual QList<QgsProviderSourceWidgetProvider *> sourceWidgetProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all source widget providers registered in provider with
``providerKey``

.. note::

   Ownership of providers is passed to the caller.

.. versionadded:: 3.18
%End

    virtual QList<const QgsMapLayerConfigWidgetFactory *> mapLayerConfigWidgetFactories( QgsMapLayer *layer = 0 );
%Docstring
Returns all map layer config widget factories associated with the
registered providers.

The optional ``layer`` argument can be used to only return factories
which support the specified layer.

.. versionadded:: 3.20
%End


};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsproviderguiregistry.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/