← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt/doc/man/man3/QwtLegend.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2011-06-10 11:22:47 UTC
  • mfrom: (1.1.6 upstream) (2.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20110610112247-0i1019vvmzaq6p86
Tags: 6.0.0-1
http://bugs.debian.org/624107
http://bugs.debian.org/604379
http://bugs.debian.org/626868
http://bugs.debian.org/626567
* New upstream release (Closes: #624107):
  - drop Qt3 support. (Closes: #604379, #626868)
* Register documentation with doc-base. (Closes: #626567)
* Drop patches:
  - 01_makefiles.diff
  - 02_add_missing_warnings.diff
  - 03_qwt_branch_pull_r544.diff
* Add qwt_install_paths.patch to fix the hardcoded installation paths.
* Update debian/control:
  - drop libqt3-mt-dev build dependency.
  - bump Standards-Version to 3.9.2 (no changes).
  - drop Qt3 related packages.
  - due to bump soname (and as we dropper Qt3 support):
    - libqwt5-qt4-dev -> libqwt-dev
    - libqwt5-qt4 -> libqwt6
    - libqwt5-doc -> libqwt-doc
* Update debian/copyright file.
* Update debian/rules: drop Qt3 packages support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt/doc/man/man3/QwtLegend.3
1
 
.TH "QwtLegend" 3 "22 Mar 2009" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtLegend \- The legend widget.  
6
 
 
7
 
.PP
8
 
.SH SYNOPSIS
9
 
.br
10
 
.PP
11
 
\fC#include <qwt_legend.h>\fP
12
 
.PP
13
 
.SS "Public Types"
14
 
 
15
 
.in +1c
16
 
.ti -1c
17
 
.RI "enum \fBLegendDisplayPolicy\fP { \fBNoIdentifier\fP =  0, \fBFixedIdentifier\fP =  1, \fBAutoIdentifier\fP =  2 }"
18
 
.br
19
 
.ti -1c
20
 
.RI "enum \fBLegendItemMode\fP { \fBReadOnlyItem\fP, \fBClickableItem\fP, \fBCheckableItem\fP }"
21
 
.br
22
 
.SS "Public Member Functions"
23
 
 
24
 
.in +1c
25
 
.ti -1c
26
 
.RI "\fBQwtLegend\fP (QWidget *parent=NULL)"
27
 
.br
28
 
.ti -1c
29
 
.RI "virtual \fB~QwtLegend\fP ()"
30
 
.br
31
 
.ti -1c
32
 
.RI "void \fBsetDisplayPolicy\fP (\fBLegendDisplayPolicy\fP policy, int mode)"
33
 
.br
34
 
.ti -1c
35
 
.RI "\fBLegendDisplayPolicy\fP \fBdisplayPolicy\fP () const "
36
 
.br
37
 
.ti -1c
38
 
.RI "void \fBsetItemMode\fP (\fBLegendItemMode\fP)"
39
 
.br
40
 
.ti -1c
41
 
.RI "\fBLegendItemMode\fP \fBitemMode\fP () const "
42
 
.br
43
 
.ti -1c
44
 
.RI "int \fBidentifierMode\fP () const "
45
 
.br
46
 
.ti -1c
47
 
.RI "QWidget * \fBcontentsWidget\fP ()"
48
 
.br
49
 
.ti -1c
50
 
.RI "const QWidget * \fBcontentsWidget\fP () const "
51
 
.br
52
 
.ti -1c
53
 
.RI "void \fBinsert\fP (const \fBQwtLegendItemManager\fP *, QWidget *)"
54
 
.br
55
 
.ti -1c
56
 
.RI "void \fBremove\fP (const \fBQwtLegendItemManager\fP *)"
57
 
.br
58
 
.ti -1c
59
 
.RI "QWidget * \fBfind\fP (const \fBQwtLegendItemManager\fP *) const "
60
 
.br
61
 
.ti -1c
62
 
.RI "\fBQwtLegendItemManager\fP * \fBfind\fP (const QWidget *) const "
63
 
.br
64
 
.ti -1c
65
 
.RI "virtual QList< QWidget * > \fBlegendItems\fP () const "
66
 
.br
67
 
.ti -1c
68
 
.RI "void \fBclear\fP ()"
69
 
.br
70
 
.ti -1c
71
 
.RI "bool \fBisEmpty\fP () const "
72
 
.br
73
 
.ti -1c
74
 
.RI "uint \fBitemCount\fP () const "
75
 
.br
76
 
.ti -1c
77
 
.RI "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
78
 
.br
79
 
.ti -1c
80
 
.RI "virtual QSize \fBsizeHint\fP () const "
81
 
.br
82
 
.ti -1c
83
 
.RI "virtual int \fBheightForWidth\fP (int w) const "
84
 
.br
85
 
.ti -1c
86
 
.RI "QScrollBar * \fBhorizontalScrollBar\fP () const "
87
 
.br
88
 
.ti -1c
89
 
.RI "QScrollBar * \fBverticalScrollBar\fP () const "
90
 
.br
91
 
.in -1c
92
 
.SS "Protected Member Functions"
93
 
 
94
 
.in +1c
95
 
.ti -1c
96
 
.RI "virtual void \fBresizeEvent\fP (QResizeEvent *)"
97
 
.br
98
 
.ti -1c
99
 
.RI "virtual void \fBlayoutContents\fP ()"
100
 
.br
101
 
.in -1c
102
 
.SH "Detailed Description"
103
 
.PP 
104
 
The legend widget. 
105
 
 
106
 
The \fBQwtLegend\fP widget is a tabular arrangement of legend items. Legend items might be any type of widget, but in general they will be a \fBQwtLegendItem\fP.
107
 
.PP
108
 
\fBSee also:\fP
109
 
.RS 4
110
 
\fBQwtLegendItem\fP, \fBQwtLegendItemManager\fP \fBQwtPlot\fP 
111
 
.RE
112
 
.PP
113
 
 
114
 
.SH "Member Enumeration Documentation"
115
 
.PP 
116
 
.SS "enum \fBQwtLegend::LegendDisplayPolicy\fP"
117
 
.PP
118
 
Display policy. 
119
 
.PP
120
 
.IP "\(bu" 2
121
 
NoIdentifier
122
 
.br
123
 
 The client code is responsible how to display of each legend item. The Qwt library will not interfere.
124
 
.PP
125
 
.PP
126
 
.IP "\(bu" 2
127
 
FixedIdentifier
128
 
.br
129
 
 All legend items are displayed with the \fBQwtLegendItem::IdentifierMode\fP to be passed in 'mode'.
130
 
.PP
131
 
.PP
132
 
.IP "\(bu" 2
133
 
AutoIdentifier
134
 
.br
135
 
 Each legend item is displayed with a mode that is a bitwise or of
136
 
.IP "  \(bu" 4
137
 
QwtLegendItem::ShowLine (if its curve is drawn with a line) and
138
 
.IP "  \(bu" 4
139
 
QwtLegendItem::ShowSymbol (if its curve is drawn with symbols) and
140
 
.IP "  \(bu" 4
141
 
QwtLegendItem::ShowText (if the has a title).
142
 
.PP
143
 
 
144
 
.PP
145
 
.PP
146
 
Default is AutoIdentifier. 
147
 
.PP
148
 
\fBSee also:\fP
149
 
.RS 4
150
 
\fBsetDisplayPolicy()\fP, \fBdisplayPolicy()\fP, \fBQwtLegendItem::IdentifierMode\fP 
151
 
.RE
152
 
.PP
153
 
 
154
 
.SS "enum \fBQwtLegend::LegendItemMode\fP"
155
 
.PP
156
 
Interaction mode for the legend items. 
157
 
.PP
158
 
.IP "\(bu" 2
159
 
ReadOnlyItem
160
 
.br
161
 
 The legend item is not interactive, like a label
162
 
.PP
163
 
.PP
164
 
.IP "\(bu" 2
165
 
ClickableItem
166
 
.br
167
 
 The legend item is clickable, like a push button
168
 
.PP
169
 
.PP
170
 
.IP "\(bu" 2
171
 
CheckableItem
172
 
.br
173
 
 The legend item is checkable, like a checkable button
174
 
.PP
175
 
.PP
176
 
Default is ReadOnlyItem. 
177
 
.PP
178
 
\fBSee also:\fP
179
 
.RS 4
180
 
\fBsetItemMode()\fP, \fBitemMode()\fP, \fBQwtLegendItem::IdentifierMode\fP \fBQwtLegendItem::clicked()\fP, \fBQwtLegendItem::checked()\fP, \fBQwtPlot::legendClicked()\fP, \fBQwtPlot::legendChecked()\fP 
181
 
.RE
182
 
.PP
183
 
 
184
 
.SH "Constructor & Destructor Documentation"
185
 
.PP 
186
 
.SS "QwtLegend::QwtLegend (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
187
 
.PP
188
 
Constructor
189
 
.PP
190
 
\fBParameters:\fP
191
 
.RS 4
192
 
\fIparent\fP Parent widget 
193
 
.RE
194
 
.PP
195
 
 
196
 
.SS "QwtLegend::~QwtLegend ()\fC [virtual]\fP"
197
 
.PP
198
 
Destructor. 
199
 
.PP
200
 
.SH "Member Function Documentation"
201
 
.PP 
202
 
.SS "void QwtLegend::clear ()"
203
 
.PP
204
 
Remove all items. 
205
 
.PP
206
 
.SS "const QWidget * QwtLegend::contentsWidget () const"
207
 
.PP
208
 
The contents widget is the only child of the viewport() and the parent widget of all legend items. 
209
 
.SS "QWidget * QwtLegend::contentsWidget ()"
210
 
.PP
211
 
The contents widget is the only child of the viewport() and the parent widget of all legend items. 
212
 
.SS "\fBQwtLegend::LegendDisplayPolicy\fP QwtLegend::displayPolicy () const"
213
 
.PP
214
 
\fBReturns:\fP
215
 
.RS 4
216
 
the legend display policy. Default is LegendDisplayPolicy::Auto. 
217
 
.RE
218
 
.PP
219
 
\fBSee also:\fP
220
 
.RS 4
221
 
\fBsetDisplayPolicy()\fP, \fBLegendDisplayPolicy\fP 
222
 
.RE
223
 
.PP
224
 
 
225
 
.SS "bool QwtLegend::eventFilter (QObject * o, QEvent * e)\fC [virtual]\fP"
226
 
.PP
227
 
Filter layout related events of \fBQwtLegend::contentsWidget()\fP.
228
 
.PP
229
 
\fBParameters:\fP
230
 
.RS 4
231
 
\fIo\fP Object to be filtered 
232
 
.br
233
 
\fIe\fP Event 
234
 
.RE
235
 
.PP
236
 
 
237
 
.SS "\fBQwtLegendItemManager\fP * QwtLegend::find (const QWidget * legendItem) const"
238
 
.PP
239
 
Find the widget that represents a plot item
240
 
.PP
241
 
\fBParameters:\fP
242
 
.RS 4
243
 
\fIlegendItem\fP Legend item 
244
 
.RE
245
 
.PP
246
 
\fBReturns:\fP
247
 
.RS 4
248
 
Widget on the legend, or NULL 
249
 
.RE
250
 
.PP
251
 
 
252
 
.SS "QWidget * QwtLegend::find (const \fBQwtLegendItemManager\fP * plotItem) const"
253
 
.PP
254
 
Find the widget that represents a plot item
255
 
.PP
256
 
\fBParameters:\fP
257
 
.RS 4
258
 
\fIplotItem\fP Plot item 
259
 
.RE
260
 
.PP
261
 
\fBReturns:\fP
262
 
.RS 4
263
 
Widget on the legend, or NULL 
264
 
.RE
265
 
.PP
266
 
 
267
 
.SS "int QwtLegend::heightForWidth (int width) const\fC [virtual]\fP"
268
 
.PP
269
 
\fBReturns:\fP
270
 
.RS 4
271
 
The preferred height, for the width w. 
272
 
.RE
273
 
.PP
274
 
\fBParameters:\fP
275
 
.RS 4
276
 
\fIwidth\fP Width 
277
 
.RE
278
 
.PP
279
 
 
280
 
.SS "QScrollBar * QwtLegend::horizontalScrollBar () const"
281
 
.PP
282
 
\fBReturns:\fP
283
 
.RS 4
284
 
Horizontal scrollbar 
285
 
.RE
286
 
.PP
287
 
\fBSee also:\fP
288
 
.RS 4
289
 
\fBverticalScrollBar()\fP 
290
 
.RE
291
 
.PP
292
 
 
293
 
.SS "int QwtLegend::identifierMode () const"
294
 
.PP
295
 
\fBReturns:\fP
296
 
.RS 4
297
 
the IdentifierMode to be used in combination with LegendDisplayPolicy::Fixed.
298
 
.RE
299
 
.PP
300
 
Default is ShowLine | ShowSymbol | ShowText. 
301
 
.SS "void QwtLegend::insert (const \fBQwtLegendItemManager\fP * plotItem, QWidget * legendItem)"
302
 
.PP
303
 
Insert a new item for a plot item 
304
 
.PP
305
 
\fBParameters:\fP
306
 
.RS 4
307
 
\fIplotItem\fP Plot item 
308
 
.br
309
 
\fIlegendItem\fP New legend item 
310
 
.RE
311
 
.PP
312
 
\fBNote:\fP
313
 
.RS 4
314
 
The parent of item will be changed to \fBQwtLegend::contentsWidget()\fP 
315
 
.RE
316
 
.PP
317
 
 
318
 
.SS "bool QwtLegend::isEmpty () const"
319
 
.PP
320
 
Return true, if there are no legend items. 
321
 
.PP
322
 
.SS "uint QwtLegend::itemCount () const"
323
 
.PP
324
 
Return the number of legend items. 
325
 
.PP
326
 
.SS "\fBQwtLegend::LegendItemMode\fP QwtLegend::itemMode () const"
327
 
.PP
328
 
\fBSee also:\fP
329
 
.RS 4
330
 
\fBLegendItemMode\fP 
331
 
.RE
332
 
.PP
333
 
 
334
 
.SS "void QwtLegend::layoutContents ()\fC [protected, virtual]\fP"
335
 
.PP
336
 
Adjust contents widget and item layout to the size of the viewport(). 
337
 
.SS "QList< QWidget * > QwtLegend::legendItems () const\fC [virtual]\fP"
338
 
.PP
339
 
Return a list of all legend items. 
340
 
.PP
341
 
.SS "void QwtLegend::remove (const \fBQwtLegendItemManager\fP * plotItem)"
342
 
.PP
343
 
Find the corresponding item for a plotItem and remove it from the item list.
344
 
.PP
345
 
\fBParameters:\fP
346
 
.RS 4
347
 
\fIplotItem\fP Plot item 
348
 
.RE
349
 
.PP
350
 
 
351
 
.SS "void QwtLegend::resizeEvent (QResizeEvent * e)\fC [protected, virtual]\fP"
352
 
.PP
353
 
Resize event 
354
 
.PP
355
 
\fBParameters:\fP
356
 
.RS 4
357
 
\fIe\fP Resize event 
358
 
.RE
359
 
.PP
360
 
 
361
 
.SS "void QwtLegend::setDisplayPolicy (\fBLegendDisplayPolicy\fP policy, int mode)"
362
 
.PP
363
 
Set the legend display policy to:
364
 
.PP
365
 
\fBParameters:\fP
366
 
.RS 4
367
 
\fIpolicy\fP Legend display policy 
368
 
.br
369
 
\fImode\fP Identifier mode (or'd ShowLine, ShowSymbol, ShowText)
370
 
.RE
371
 
.PP
372
 
\fBSee also:\fP
373
 
.RS 4
374
 
\fBdisplayPolicy()\fP, \fBLegendDisplayPolicy\fP 
375
 
.RE
376
 
.PP
377
 
 
378
 
.SS "void QwtLegend::setItemMode (\fBLegendItemMode\fP mode)"
379
 
.PP
380
 
\fBSee also:\fP
381
 
.RS 4
382
 
\fBLegendItemMode\fP 
383
 
.RE
384
 
.PP
385
 
 
386
 
.SS "QSize QwtLegend::sizeHint () const\fC [virtual]\fP"
387
 
.PP
388
 
Return a size hint. 
389
 
.PP
390
 
.SS "QScrollBar * QwtLegend::verticalScrollBar () const"
391
 
.PP
392
 
\fBReturns:\fP
393
 
.RS 4
394
 
Vertical scrollbar 
395
 
.RE
396
 
.PP
397
 
\fBSee also:\fP
398
 
.RS 4
399
 
\fBhorizontalScrollBar()\fP 
400
 
.RE
401
 
.PP
402
 
 
403
 
 
404
 
.SH "Author"
405
 
.PP 
406
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.