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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsoptional.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
template<T>
class QgsOptional
{
%Docstring(signature="appended")
:py:class:`QgsOptional` is a container for other classes and adds an
additional enabled/disabled flag.
Often it is used for configuration options which can be enabled or
disabled but also have more internal configuration information that
should not be lost when disabling and re-enabling.
.. note::
For Python you need to use implementations for specific template classes
.. note::
Not available in Python bindings (although SIP file is present for specific implementations).
%End
%TypeHeaderCode
#include "qgsoptional.h"
%End
public:
QgsOptional();
%Docstring
A QgsOptional is disabled by default if default constructed.
%End
QgsOptional( const T &data );
%Docstring
A QgsOptional is enabled by default if constructed with payload.
%End
QgsOptional( const T &data, bool enabled );
%Docstring
A QgsOptional constructed with enabled status and data
%End
bool operator== ( const QgsOptional<T> &other ) const;
bool enabled() const;
%Docstring
Check if this optional is enabled
%End
void setEnabled( bool enabled );
%Docstring
Set if this optional is enabled
%End
T data() const;
%Docstring
Access the payload data
%End
void setData( const T &data );
%Docstring
Set the payload data
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsoptional.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
