File: qgsnumericformatguiregistry.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 (88 lines) | stat: -rw-r--r-- 2,898 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/numericformats/qgsnumericformatguiregistry.h                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsNumericFormatConfigurationWidgetFactory
{
%Docstring(signature="appended")
Interface base class for factories for numeric format configuration
widgets.

.. versionadded:: 3.12
%End

%TypeHeaderCode
#include "qgsnumericformatguiregistry.h"
%End
  public:
    virtual ~QgsNumericFormatConfigurationWidgetFactory();

    virtual QgsNumericFormatWidget *create( const QgsNumericFormat *format ) const = 0 /TransferBack/;
%Docstring
Create a new configuration widget for a format.
%End
};

class QgsNumericFormatGuiRegistry
{
%Docstring(signature="appended")
The :py:class:`QgsNumericFormatGuiRegistry` is a home for widgets for
configuring :py:class:`QgsNumericFormat` objects.

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

.. versionadded:: 3.12
%End

%TypeHeaderCode
#include "qgsnumericformatguiregistry.h"
%End
  public:
    QgsNumericFormatGuiRegistry();
%Docstring
Constructor. Should never be called manually, is already created by
:py:class:`QgsGui`.
%End
    ~QgsNumericFormatGuiRegistry();

    void addFormatConfigurationWidgetFactory( const QString &id, QgsNumericFormatConfigurationWidgetFactory *factory /Transfer/ );
%Docstring
Add a new configuration widget factory for customizing a numeric format
with the specified ``id``.

Ownership is taken by the reigstry.
%End

    void removeFormatConfigurationWidgetFactory( const QString &id );
%Docstring
Removes the configuration widget factory for customizing numeric formats
with the specified ``id``.
%End

    QgsNumericFormatWidget *formatConfigurationWidget( const QgsNumericFormat *format ) const /TransferBack/;
%Docstring
Returns a new configuration widget for an ``format``.

Returns ``None`` if no configuration widgets are available for the
specified ``format``.
%End

};

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