File: qgscolorramplegendnodewidget.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 (134 lines) | stat: -rw-r--r-- 4,435 bytes parent folder | download | duplicates (6)
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgscolorramplegendnodewidget.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsColorRampLegendNodeWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A widget for properties relating to a :py:class:`QgsColorRampLegendNode`
(:py:class:`QgsColorRampLegendNodeSettings`).

The current settings are set by a call to :py:func:`~setSettings`, and
the settings defined by the widget are retrieved by calling
:py:func:`~settings`.

When changes are made the to settings by a user the
:py:func:`~widgetChanged` signal is emitted.

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgscolorramplegendnodewidget.h"
%End
  public:
    enum class Capability /BaseType=IntFlag/
    {
      Prefix,
      Suffix,
      NumberFormat,
      DefaultMinimum,
      DefaultMaximum,
      AllCapabilities,
    };

    typedef QFlags<QgsColorRampLegendNodeWidget::Capability> Capabilities;


    QgsColorRampLegendNodeWidget( QWidget *parent = 0, QgsColorRampLegendNodeWidget::Capabilities capabilities = QgsColorRampLegendNodeWidget::Capability::AllCapabilities );
%Docstring
Constructor for QgsColorRampLegendNodeWidget, with the specified
``parent`` widget.

Since QGIS 3.38, the ``capabilities`` argument can be used to fine-tune
settings exposed in the widget.
%End

    QgsColorRampLegendNodeSettings settings() const;
%Docstring
Returns the legend node settings as defined by the widget.

.. seealso:: :py:func:`setSettings`
%End

    void setSettings( const QgsColorRampLegendNodeSettings &settings );
%Docstring
Sets the settings to show in the widget.

.. seealso:: :py:func:`settings`
%End

    void setUseContinuousRampCheckBoxVisibility( bool visible );
%Docstring
Sets visibility for the "Use Continuous Legend" checkbox to ``visible``.

This widget is visible and checked by default but in a few cases it does
not need to be visible because disabling it would not make sense (for
instance when using single band gray renderer).
%End

};
QFlags<QgsColorRampLegendNodeWidget::Capability> operator|(QgsColorRampLegendNodeWidget::Capability f1, QFlags<QgsColorRampLegendNodeWidget::Capability> f2);


class QgsColorRampLegendNodeDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring a :py:class:`QgsColorRampLegendNode`
(:py:class:`QgsColorRampLegendNodeSettings`).

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgscolorramplegendnodewidget.h"
%End
  public:
    QgsColorRampLegendNodeDialog( const QgsColorRampLegendNodeSettings &settings, QWidget *parent /TransferThis/ = 0, QgsColorRampLegendNodeWidget::Capabilities capabilities = QgsColorRampLegendNodeWidget::Capability::AllCapabilities );
%Docstring
Constructor for QgsColorRampLegendNodeDialog, initially showing the
specified ``settings``.

Since QGIS 3.38, the ``capabilities`` argument can be used to fine-tune
settings exposed in the dialog.
%End

    QgsColorRampLegendNodeSettings settings() const;
%Docstring
Returns the legend node settings as defined by the dialog.
%End

    QDialogButtonBox *buttonBox() const;
%Docstring
Returns a reference to the dialog's button box.
%End

    void setUseContinuousRampCheckBoxVisibility( bool visible );
%Docstring
Sets visibility for the "Use Continuous Legend" checkbox in the legend
settings dialog to ``visible``.

This widget is visible and checked by default but in a few cases it does
not need to be visible because disabling it would not make sense (for
instance when using single band gray renderer).
%End

};


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