File: qgshistogramwidget.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 (212 lines) | stat: -rw-r--r-- 5,451 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
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgshistogramwidget.h                                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





typedef QPointF QwtDoublePoint;


class QgsHistogramWidget : QWidget
{
%Docstring(signature="appended")
Graphical histogram for displaying distributions of field values.
%End

%TypeHeaderCode
#include "qgshistogramwidget.h"
%End
  public:
    QgsHistogramWidget( QWidget *parent /TransferThis/ = 0, QgsVectorLayer *layer = 0, const QString &fieldOrExp = QString() );
%Docstring
QgsHistogramWidget constructor. If layer and fieldOrExp are specified
then the histogram will be initially populated with the corresponding
values.

:param parent: parent widget
:param layer: source vector layer
:param fieldOrExp: field name or expression string
%End

    ~QgsHistogramWidget();

    QgsVectorLayer *layer();
%Docstring
Returns the layer currently associated with the widget.

.. seealso:: :py:func:`setLayer`

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

    QString sourceFieldExp() const;
%Docstring
Returns the source field name or expression used to calculate values
displayed in the histogram.

.. seealso:: :py:func:`setSourceFieldExp`

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

    void setPen( const QPen &pen );
%Docstring
Sets the pen to use when drawing histogram bars. If set to Qt.NoPen then
the pen will be automatically calculated. If ranges have been set using
:py:func:`~QgsHistogramWidget.setGraduatedRanges` then the pen and brush
will have no effect.

:param pen: histogram pen

.. seealso:: :py:func:`pen`

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

    QPen pen() const;
%Docstring
Returns the pen used when drawing histogram bars.

.. seealso:: :py:func:`setPen`

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

    void setBrush( const QBrush &brush );
%Docstring
Sets the brush used for drawing histogram bars. If ranges have been set
using :py:func:`~QgsHistogramWidget.setGraduatedRanges` then the pen and
brush will have no effect.

:param brush: histogram brush

.. seealso:: :py:func:`brush`

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

    QBrush brush() const;
%Docstring
Returns the brush used when drawing histogram bars.

.. seealso:: :py:func:`setBrush`

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

    void setGraduatedRanges( const QgsRangeList &ranges );
%Docstring
Sets the graduated ranges associated with the histogram. If set, the
ranges will be used to color the histogram bars and for showing vertical
dividers at the histogram breaks.

:param ranges: graduated range list

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

    QgsRangeList graduatedRanges() const;
%Docstring
Returns the graduated ranges associated with the histogram. If set, the
ranges will be used to color the histogram bars and for showing vertical
dividers at the histogram breaks.

:return: graduated range list

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

    QString xAxisTitle() const;
%Docstring
Returns the title for the histogram's x-axis.

.. seealso:: :py:func:`setXAxisTitle`

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

    void setXAxisTitle( const QString &title );
%Docstring
Sets the title for the histogram's x-axis.

:param title: x-axis title, or empty string to remove title

.. seealso:: :py:func:`xAxisTitle`

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

    QString yAxisTitle() const;
%Docstring
Returns the title for the histogram's y-axis.

.. seealso:: :py:func:`setYAxisTitle`

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

    void setYAxisTitle( const QString &title );
%Docstring
Sets the title for the histogram's y-axis.

:param title: y-axis title, or empty string to remove title

.. seealso:: :py:func:`yAxisTitle`

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

  public slots:

    void refreshValues();
%Docstring
Refreshes the values for the histogram by fetching them from the layer.
%End

    void refresh();
%Docstring
Redraws the histogram. Calling this slot does not update the values for
the histogram, use :py:func:`~QgsHistogramWidget.refreshValues` to do
this.
%End

    void setLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector layer associated with the histogram.

:param layer: source vector layer

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

    void setSourceFieldExp( const QString &fieldOrExp );
%Docstring
Sets the source field or expression to use for values in the histogram.

:param fieldOrExp: field name or expression string

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

  protected:
    virtual void drawHistogram();
%Docstring
Updates and redraws the histogram.
%End


};

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