File: qgsprovidersourcewidgetprovider.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (61 lines) | stat: -rw-r--r-- 2,227 bytes parent folder | download | duplicates (5)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsprovidersourcewidgetprovider.h                            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/




class QgsProviderSourceWidgetProvider
{
%Docstring(signature="appended")

An interface for providers of widgets designed to configure a data provider's source.

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgsprovidersourcewidgetprovider.h"
%End
  public:

    virtual ~QgsProviderSourceWidgetProvider();

    virtual QString providerKey() const = 0;
%Docstring
Provider key
%End

    virtual QString name() const;
%Docstring
Source widget provider name, this is useful to retrieve
a particular source widget provider in case the provider has more
than one, it should be unique among all providers.

The default implementation returns the :py:func:`~QgsProviderSourceWidgetProvider.providerKey`
%End

    virtual bool canHandleLayer( QgsMapLayer *layer ) const = 0;
%Docstring
Returns ``True`` if the provider can handle the specified ``layer``.
%End

    virtual QgsProviderSourceWidget *createWidget( QgsMapLayer *layer, QWidget *parent /TransferThis/ = 0 ) = 0 /Factory/;
%Docstring
Creates a new widget to configure the source of the specified ``layer``.
It may return ``None`` if it cannot handle the layer.
The returned object must be destroyed by the caller.
%End
};

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