@@ -36,13 +36,16 @@ class QgsCoordinateReferenceSystem;
36
36
37
37
/* * \ingroup core
38
38
* A registry / canonical manager of data providers.
39
-
40
- This is a Singleton class that manages data provider access.
41
-
42
- Loaded providers may be restricted using QGIS_PROVIDER_FILE environment variable.
43
- QGIS_PROVIDER_FILE is regexp pattern applied to provider file name (not provider key).
44
- For example, if the variable is set to gdal|ogr|postgres it will load only providers gdal,
45
- ogr and postgres.
39
+ *
40
+ * This is a Singleton class that manages data provider access.
41
+ *
42
+ * Providers can be either loaded via libraries or native providers that
43
+ * are included in the core QGIS installation and accessed through function pointers.
44
+ *
45
+ * Loaded providers may be restricted using QGIS_PROVIDER_FILE environment variable.
46
+ * QGIS_PROVIDER_FILE is regexp pattern applied to provider file name (not provider key).
47
+ * For example, if the variable is set to gdal|ogr|postgres it will load only providers gdal,
48
+ * ogr and postgres.
46
49
*/
47
50
class CORE_EXPORT QgsProviderRegistry
48
51
{
@@ -54,13 +57,20 @@ class CORE_EXPORT QgsProviderRegistry
54
57
55
58
virtual ~QgsProviderRegistry ();
56
59
57
- // ! Return path for the library of the provider
60
+ /* *
61
+ * Return path for the library of the provider.
62
+ *
63
+ * If the provider uses direct provider function pointers instead of a library an empty string will
64
+ * be returned.
65
+ */
58
66
QString library ( const QString &providerKey ) const ;
59
67
60
68
// ! Return list of provider plugins found
61
69
QString pluginList ( bool asHtml = false ) const ;
62
70
63
- // ! Return library directory where plugins are found
71
+ /* *
72
+ * Returns the library directory where plugins are found.
73
+ */
64
74
QDir libraryDirectory () const ;
65
75
66
76
// ! Set library directory where to search for plugins
@@ -85,17 +95,22 @@ class CORE_EXPORT QgsProviderRegistry
85
95
QWidget *selectWidget ( const QString &providerKey,
86
96
QWidget *parent = nullptr , Qt::WindowFlags fl = Qt::WindowFlags() );
87
97
88
- /* * Get pointer to provider function
89
- \param providerKey identificator of the provider
90
- \param functionName name of function
91
- \returns pointer to function or NULL on error
98
+ /* *
99
+ * Get pointer to provider function
100
+ * \param providerKey identificator of the provider
101
+ * \param functionName name of function
102
+ * \returns pointer to function or NULL on error. If the provider uses direct provider
103
+ * function pointers instead of a library nullptr will be returned.
92
104
*/
93
105
QFunctionPointer function ( const QString &providerKey,
94
106
const QString &functionName );
95
107
96
108
/* *
97
109
* Returns a new QLibrary for the specified \a providerKey. Ownership of the returned
98
110
* object is transferred to the caller and the caller is responsible for deleting it.
111
+ *
112
+ * If the provider uses direct provider function pointers instead of a library nullptr will
113
+ * be returned.
99
114
*/
100
115
QLibrary *providerLibrary ( const QString &providerKey ) const ;
101
116
0 commit comments