File: qgsfieldformatterregistry.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; 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: 154
file content (90 lines) | stat: -rw-r--r-- 2,965 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsfieldformatterregistry.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsFieldFormatterRegistry : QObject
{
%Docstring(signature="appended")
The :py:class:`QgsFieldFormatterRegistry` manages registered classes of
:py:class:`QgsFieldFormatter`.

A reference to the :py:class:`QgsFieldFormatterRegistry` can be obtained
from :py:func:`QgsApplication.fieldFormatterRegistry()`.
%End

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

    explicit QgsFieldFormatterRegistry( QObject *parent /TransferThis/ = 0 );
%Docstring
You should not normally need to create your own field formatter
registry.

Use the one provided by
`:py:func:`QgsApplication.fieldFormatterRegistry()`` instead.
%End
    ~QgsFieldFormatterRegistry();

    void addFieldFormatter( QgsFieldFormatter *formatter /Transfer/ );
%Docstring
They will take precedence in order of adding them. The later they are
added, the more weight they have.

Ownership is transferred to the registry.
%End

    void removeFieldFormatter( QgsFieldFormatter *formatter );
%Docstring
Remove a field formatter from the registry. The field formatter will be
deleted.
%End

    void removeFieldFormatter( const QString &id );
%Docstring
Remove the field formatter with the specified id.
%End

    QgsFieldFormatter *fieldFormatter( const QString &id ) const;
%Docstring
Gets a field formatter by its id. If there is no such id registered, a
default :py:class:`QgsFallbackFieldFormatter` with a null id will be
returned instead.
%End

    QgsFieldFormatter *fallbackFieldFormatter() const;
%Docstring
Returns a basic fallback field formatter which can be used to represent
any field in an unspectacular manner.
%End

  signals:

    void fieldFormatterAdded( QgsFieldFormatter *formatter );
%Docstring
Will be emitted after a new field formatter has been added.
%End

    void fieldFormatterRemoved( QgsFieldFormatter *formatter );
%Docstring
Will be emitted just before a field formatter is removed and deleted.
%End

};

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