← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtLegendItem.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtLegendItem.3
 
1
.TH "QwtLegendItem" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtLegendItem \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtTextLabel\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A legend label. 
 
14
 
 
15
\fBQwtLegendItem\fP represents a curve on a legend. It displays an curve identifier with an explaining text. The identifier might be a combination of curve symbol and line. In readonly mode it behaves like a label, otherwise like an unstylish push button.
 
16
.PP
 
17
\fBSee also:\fP
 
18
.RS 4
 
19
\fBQwtLegend\fP, \fBQwtPlotCurve\fP 
 
20
.RE
 
21
.PP
 
22
 
 
23
.PP
 
24
Definition at line 35 of file qwt_legend_item.h.
 
25
.SS "Public Types"
 
26
 
 
27
.in +1c
 
28
.ti -1c
 
29
.RI "enum \fBIdentifierMode\fP { \fBNoIdentifier\fP =  0, \fBShowLine\fP =  1, \fBShowSymbol\fP =  2, \fBShowText\fP =  4 }"
 
30
.br
 
31
.in -1c
 
32
.SS "Public Slots"
 
33
 
 
34
.in +1c
 
35
.ti -1c
 
36
.RI "void \fBsetChecked\fP (bool on)"
 
37
.br
 
38
.in -1c
 
39
.SS "Signals"
 
40
 
 
41
.in +1c
 
42
.ti -1c
 
43
.RI "void \fBclicked\fP ()"
 
44
.br
 
45
.ti -1c
 
46
.RI "void \fBpressed\fP ()"
 
47
.br
 
48
.ti -1c
 
49
.RI "void \fBreleased\fP ()"
 
50
.br
 
51
.ti -1c
 
52
.RI "void \fBchecked\fP (bool)"
 
53
.br
 
54
.in -1c
 
55
.SS "Public Member Functions"
 
56
 
 
57
.in +1c
 
58
.ti -1c
 
59
.RI "\fBQwtLegendItem\fP (QWidget *parent=0)"
 
60
.br
 
61
.ti -1c
 
62
.RI "\fBQwtLegendItem\fP (const \fBQwtSymbol\fP &, const QPen &, const \fBQwtText\fP &, QWidget *parent=0)"
 
63
.br
 
64
.ti -1c
 
65
.RI "virtual \fB~QwtLegendItem\fP ()"
 
66
.br
 
67
.ti -1c
 
68
.RI "virtual void \fBsetText\fP (const \fBQwtText\fP &)"
 
69
.br
 
70
.ti -1c
 
71
.RI "void \fBsetItemMode\fP (\fBQwtLegend::LegendItemMode\fP)"
 
72
.br
 
73
.ti -1c
 
74
.RI "\fBQwtLegend::LegendItemMode\fP \fBitemMode\fP () const"
 
75
.br
 
76
.ti -1c
 
77
.RI "void \fBsetIdentifierMode\fP (int)"
 
78
.br
 
79
.ti -1c
 
80
.RI "int \fBidentifierMode\fP () const"
 
81
.br
 
82
.ti -1c
 
83
.RI "void \fBsetIdentfierWidth\fP (int width)"
 
84
.br
 
85
.ti -1c
 
86
.RI "int \fBidentifierWidth\fP () const"
 
87
.br
 
88
.ti -1c
 
89
.RI "void \fBsetSpacing\fP (int spacing)"
 
90
.br
 
91
.ti -1c
 
92
.RI "int \fBspacing\fP () const"
 
93
.br
 
94
.ti -1c
 
95
.RI "void \fBsetSymbol\fP (const \fBQwtSymbol\fP &)"
 
96
.br
 
97
.ti -1c
 
98
.RI "const \fBQwtSymbol\fP & \fBsymbol\fP () const"
 
99
.br
 
100
.ti -1c
 
101
.RI "void \fBsetCurvePen\fP (const QPen &)"
 
102
.br
 
103
.ti -1c
 
104
.RI "const QPen & \fBcurvePen\fP () const"
 
105
.br
 
106
.ti -1c
 
107
.RI "virtual void \fBdrawIdentifier\fP (QPainter *, const QRect &) const"
 
108
.br
 
109
.ti -1c
 
110
.RI "virtual void \fBdrawItem\fP (QPainter *p, const QRect &) const"
 
111
.br
 
112
.ti -1c
 
113
.RI "virtual QSize \fBsizeHint\fP () const"
 
114
.br
 
115
.ti -1c
 
116
.RI "bool \fBisChecked\fP () const"
 
117
.br
 
118
.in -1c
 
119
.SS "Protected Member Functions"
 
120
 
 
121
.in +1c
 
122
.ti -1c
 
123
.RI "void \fBsetDown\fP (bool)"
 
124
.br
 
125
.ti -1c
 
126
.RI "bool \fBisDown\fP () const"
 
127
.br
 
128
.ti -1c
 
129
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *)"
 
130
.br
 
131
.ti -1c
 
132
.RI "virtual void \fBmousePressEvent\fP (QMouseEvent *)"
 
133
.br
 
134
.ti -1c
 
135
.RI "virtual void \fBmouseReleaseEvent\fP (QMouseEvent *)"
 
136
.br
 
137
.ti -1c
 
138
.RI "virtual void \fBkeyPressEvent\fP (QKeyEvent *)"
 
139
.br
 
140
.ti -1c
 
141
.RI "virtual void \fBkeyReleaseEvent\fP (QKeyEvent *)"
 
142
.br
 
143
.ti -1c
 
144
.RI "virtual void \fBdrawText\fP (QPainter *, const QRect &)"
 
145
.br
 
146
.in -1c
 
147
.SH "Member Enumeration Documentation"
 
148
.PP 
 
149
.SS "enum \fBQwtLegendItem::IdentifierMode\fP"
 
150
.PP
 
151
Identifier mode. 
 
152
.PP
 
153
Default is ShowLine | ShowText 
 
154
.PP
 
155
\fBSee also:\fP
 
156
.RS 4
 
157
\fBQwtLegendItem::identifierMode\fP, \fBQwtLegendItem::setIdentifierMode\fP 
 
158
.RE
 
159
.PP
 
160
 
 
161
.PP
 
162
Definition at line 47 of file qwt_legend_item.h.
 
163
.SH "Constructor & Destructor Documentation"
 
164
.PP 
 
165
.SS "QwtLegendItem::QwtLegendItem (QWidget * parent = \fC0\fP)\fC [explicit]\fP"
 
166
.PP
 
167
\fBParameters:\fP
 
168
.RS 4
 
169
\fIparent\fP Parent widget 
 
170
.RE
 
171
.PP
 
172
 
 
173
.PP
 
174
Definition at line 80 of file qwt_legend_item.cpp.
 
175
.SS "QwtLegendItem::QwtLegendItem (const \fBQwtSymbol\fP & symbol, const QPen & curvePen, const \fBQwtText\fP & text, QWidget * parent = \fC0\fP)\fC [explicit]\fP"
 
176
.PP
 
177
\fBParameters:\fP
 
178
.RS 4
 
179
\fIsymbol\fP Curve symbol 
 
180
.br
 
181
\fIcurvePen\fP Curve pen 
 
182
.br
 
183
\fItext\fP Label text 
 
184
.br
 
185
\fIparent\fP Parent widget 
 
186
.RE
 
187
.PP
 
188
 
 
189
.PP
 
190
Definition at line 93 of file qwt_legend_item.cpp.
 
191
.PP
 
192
References QwtSymbol::clone(), symbol(), and QwtTextLabel::text().
 
193
.SS "QwtLegendItem::~QwtLegendItem ()\fC [virtual]\fP"
 
194
.PP
 
195
Destructor. 
 
196
.PP
 
197
Definition at line 116 of file qwt_legend_item.cpp.
 
198
.SH "Member Function Documentation"
 
199
.PP 
 
200
.SS "void QwtLegendItem::setText (const \fBQwtText\fP & text)\fC [virtual]\fP"
 
201
.PP
 
202
Set the text to the legend item
 
203
.PP
 
204
\fBParameters:\fP
 
205
.RS 4
 
206
\fItext\fP Text label 
 
207
.RE
 
208
.PP
 
209
\fBSee also:\fP
 
210
.RS 4
 
211
\fBQwtTextLabel::text()\fP 
 
212
.RE
 
213
.PP
 
214
 
 
215
.PP
 
216
Reimplemented from \fBQwtTextLabel\fP.
 
217
.PP
 
218
Definition at line 128 of file qwt_legend_item.cpp.
 
219
.PP
 
220
References QwtText::setRenderFlags(), QwtTextLabel::setText(), and QwtTextLabel::text().
 
221
.SS "void QwtLegendItem::setItemMode (\fBQwtLegend::LegendItemMode\fP mode)"
 
222
.PP
 
223
Set the item mode The default is QwtLegend::ReadOnlyItem
 
224
.PP
 
225
\fBParameters:\fP
 
226
.RS 4
 
227
\fImode\fP Item mode 
 
228
.RE
 
229
.PP
 
230
\fBSee also:\fP
 
231
.RS 4
 
232
\fBitemMode()\fP 
 
233
.RE
 
234
.PP
 
235
 
 
236
.PP
 
237
Definition at line 150 of file qwt_legend_item.cpp.
 
238
.PP
 
239
References QwtTextLabel::setMargin().
 
240
.SS "\fBQwtLegend::LegendItemMode\fP QwtLegendItem::itemMode () const"
 
241
.PP
 
242
Return the item mode
 
243
.PP
 
244
\fBSee also:\fP
 
245
.RS 4
 
246
\fBsetItemMode()\fP 
 
247
.RE
 
248
.PP
 
249
 
 
250
.PP
 
251
Definition at line 169 of file qwt_legend_item.cpp.
 
252
.SS "void QwtLegendItem::setIdentifierMode (int mode)"
 
253
.PP
 
254
Set identifier mode. Default is ShowLine | ShowText. 
 
255
.PP
 
256
\fBParameters:\fP
 
257
.RS 4
 
258
\fImode\fP Or'd values of IdentifierMode
 
259
.RE
 
260
.PP
 
261
\fBSee also:\fP
 
262
.RS 4
 
263
\fBidentifierMode()\fP 
 
264
.RE
 
265
.PP
 
266
 
 
267
.PP
 
268
Definition at line 181 of file qwt_legend_item.cpp.
 
269
.SS "int QwtLegendItem::identifierMode () const"
 
270
.PP
 
271
Or'd values of IdentifierMode. 
 
272
.PP
 
273
\fBSee also:\fP
 
274
.RS 4
 
275
\fBsetIdentifierMode()\fP, \fBIdentifierMode\fP 
 
276
.RE
 
277
.PP
 
278
 
 
279
.PP
 
280
Definition at line 194 of file qwt_legend_item.cpp.
 
281
.SS "void QwtLegendItem::setIdentfierWidth (int width)"
 
282
.PP
 
283
Set the width for the identifier Default is 8 pixels
 
284
.PP
 
285
\fBParameters:\fP
 
286
.RS 4
 
287
\fIwidth\fP New width
 
288
.RE
 
289
.PP
 
290
\fBSee also:\fP
 
291
.RS 4
 
292
\fBidentifierMode()\fP, \fBidentifierWidth\fP 
 
293
.RE
 
294
.PP
 
295
 
 
296
.PP
 
297
Definition at line 207 of file qwt_legend_item.cpp.
 
298
.PP
 
299
References QwtTextLabel::margin(), and QwtTextLabel::setIndent().
 
300
.SS "int QwtLegendItem::identifierWidth () const"
 
301
.PP
 
302
Return the width of the identifier
 
303
.PP
 
304
\fBSee also:\fP
 
305
.RS 4
 
306
\fBsetIdentfierWidth\fP 
 
307
.RE
 
308
.PP
 
309
 
 
310
.PP
 
311
Definition at line 222 of file qwt_legend_item.cpp.
 
312
.PP
 
313
Referenced by drawItem().
 
314
.SS "void QwtLegendItem::setSpacing (int spacing)"
 
315
.PP
 
316
Change the spacing 
 
317
.PP
 
318
\fBParameters:\fP
 
319
.RS 4
 
320
\fIspacing\fP Spacing 
 
321
.RE
 
322
.PP
 
323
\fBSee also:\fP
 
324
.RS 4
 
325
\fBspacing()\fP, \fBidentifierWidth()\fP, \fBQwtTextLabel::margin()\fP 
 
326
.RE
 
327
.PP
 
328
 
 
329
.PP
 
330
Definition at line 232 of file qwt_legend_item.cpp.
 
331
.PP
 
332
References QwtTextLabel::margin(), and QwtTextLabel::setIndent().
 
333
.SS "int QwtLegendItem::spacing () const"
 
334
.PP
 
335
Return the spacing 
 
336
.PP
 
337
\fBSee also:\fP
 
338
.RS 4
 
339
\fBsetSpacing()\fP, \fBidentifierWidth()\fP, \fBQwtTextLabel::margin()\fP 
 
340
.RE
 
341
.PP
 
342
 
 
343
.PP
 
344
Definition at line 247 of file qwt_legend_item.cpp.
 
345
.PP
 
346
Referenced by drawItem().
 
347
.SS "void QwtLegendItem::setSymbol (const \fBQwtSymbol\fP & symbol)"
 
348
.PP
 
349
Set curve symbol. 
 
350
.PP
 
351
\fBParameters:\fP
 
352
.RS 4
 
353
\fIsymbol\fP Symbol
 
354
.RE
 
355
.PP
 
356
\fBSee also:\fP
 
357
.RS 4
 
358
\fBsymbol()\fP 
 
359
.RE
 
360
.PP
 
361
 
 
362
.PP
 
363
Definition at line 258 of file qwt_legend_item.cpp.
 
364
.PP
 
365
References QwtSymbol::clone(), and symbol().
 
366
.SS "const \fBQwtSymbol\fP & QwtLegendItem::symbol () const"
 
367
.PP
 
368
\fBReturns:\fP
 
369
.RS 4
 
370
The curve symbol. 
 
371
.RE
 
372
.PP
 
373
\fBSee also:\fP
 
374
.RS 4
 
375
\fBsetSymbol()\fP 
 
376
.RE
 
377
.PP
 
378
 
 
379
.PP
 
380
Definition at line 269 of file qwt_legend_item.cpp.
 
381
.PP
 
382
Referenced by QwtLegendItem(), and setSymbol().
 
383
.SS "void QwtLegendItem::setCurvePen (const QPen & pen)"
 
384
.PP
 
385
Set curve pen. 
 
386
.PP
 
387
\fBParameters:\fP
 
388
.RS 4
 
389
\fIpen\fP Curve pen
 
390
.RE
 
391
.PP
 
392
\fBSee also:\fP
 
393
.RS 4
 
394
\fBcurvePen()\fP 
 
395
.RE
 
396
.PP
 
397
 
 
398
.PP
 
399
Definition at line 281 of file qwt_legend_item.cpp.
 
400
.SS "const QPen & QwtLegendItem::curvePen () const"
 
401
.PP
 
402
\fBReturns:\fP
 
403
.RS 4
 
404
The curve pen. 
 
405
.RE
 
406
.PP
 
407
\fBSee also:\fP
 
408
.RS 4
 
409
\fBsetCurvePen()\fP 
 
410
.RE
 
411
.PP
 
412
 
 
413
.PP
 
414
Definition at line 294 of file qwt_legend_item.cpp.
 
415
.SS "void QwtLegendItem::drawIdentifier (QPainter * painter, const QRect & rect) const\fC [virtual]\fP"
 
416
.PP
 
417
Paint the identifier to a given rect. 
 
418
.PP
 
419
\fBParameters:\fP
 
420
.RS 4
 
421
\fIpainter\fP Painter 
 
422
.br
 
423
\fIrect\fP Rect where to paint 
 
424
.RE
 
425
.PP
 
426
 
 
427
.PP
 
428
Definition at line 304 of file qwt_legend_item.cpp.
 
429
.PP
 
430
References QwtPainter::drawLine(), QwtPainter::metricsMap(), and QwtMetricsMap::screenToLayout().
 
431
.PP
 
432
Referenced by drawItem(), and paintEvent().
 
433
.SS "void QwtLegendItem::drawItem (QPainter * painter, const QRect & rect) const\fC [virtual]\fP"
 
434
.PP
 
435
Draw the legend item to a given rect. 
 
436
.PP
 
437
\fBParameters:\fP
 
438
.RS 4
 
439
\fIpainter\fP Painter 
 
440
.br
 
441
\fIrect\fP Rect where to paint the button 
 
442
.RE
 
443
.PP
 
444
 
 
445
.PP
 
446
Definition at line 360 of file qwt_legend_item.cpp.
 
447
.PP
 
448
References QwtText::draw(), drawIdentifier(), identifierWidth(), QwtTextLabel::margin(), QwtPainter::metricsMap(), QwtMetricsMap::screenToLayoutX(), spacing(), and QwtTextLabel::text().
 
449
.SS "QSize QwtLegendItem::sizeHint () const\fC [virtual]\fP"
 
450
.PP
 
451
Return a size hint. 
 
452
.PP
 
453
Reimplemented from \fBQwtTextLabel\fP.
 
454
.PP
 
455
Definition at line 578 of file qwt_legend_item.cpp.
 
456
.PP
 
457
References QwtTextLabel::sizeHint().
 
458
.SS "bool QwtLegendItem::isChecked () const"
 
459
.PP
 
460
Return true, if the item is checked. 
 
461
.PP
 
462
Definition at line 542 of file qwt_legend_item.cpp.
 
463
.PP
 
464
References isDown().
 
465
.SS "void QwtLegendItem::setChecked (bool on)\fC [slot]\fP"
 
466
.PP
 
467
Check/Uncheck a the item
 
468
.PP
 
469
\fBParameters:\fP
 
470
.RS 4
 
471
\fIon\fP check/uncheck 
 
472
.RE
 
473
.PP
 
474
\fBSee also:\fP
 
475
.RS 4
 
476
\fBsetItemMode()\fP 
 
477
.RE
 
478
.PP
 
479
 
 
480
.PP
 
481
Definition at line 528 of file qwt_legend_item.cpp.
 
482
.PP
 
483
References setDown().
 
484
.SS "void QwtLegendItem::clicked ()\fC [signal]\fP"
 
485
.PP
 
486
Signal, when the legend item has been clicked. 
 
487
.PP
 
488
Referenced by setDown().
 
489
.SS "void QwtLegendItem::pressed ()\fC [signal]\fP"
 
490
.PP
 
491
Signal, when the legend item has been pressed. 
 
492
.PP
 
493
Referenced by setDown().
 
494
.SS "void QwtLegendItem::released ()\fC [signal]\fP"
 
495
.PP
 
496
Signal, when the legend item has been relased. 
 
497
.PP
 
498
Referenced by setDown().
 
499
.SS "void QwtLegendItem::checked (bool)\fC [signal]\fP"
 
500
.PP
 
501
Signal, when the legend item has been toggled. 
 
502
.PP
 
503
Referenced by setDown().
 
504
.SS "void QwtLegendItem::setDown (bool)\fC [protected]\fP"
 
505
.PP
 
506
Set the item being down. 
 
507
.PP
 
508
Definition at line 548 of file qwt_legend_item.cpp.
 
509
.PP
 
510
References checked(), clicked(), pressed(), and released().
 
511
.PP
 
512
Referenced by keyPressEvent(), keyReleaseEvent(), mousePressEvent(), mouseReleaseEvent(), and setChecked().
 
513
.SS "bool QwtLegendItem::isDown () const\fC [protected]\fP"
 
514
.PP
 
515
Return true, if the item is down. 
 
516
.PP
 
517
Definition at line 572 of file qwt_legend_item.cpp.
 
518
.PP
 
519
Referenced by isChecked(), keyPressEvent(), and mousePressEvent().
 
520
.SS "void QwtLegendItem::paintEvent (QPaintEvent *)\fC [protected, virtual]\fP"
 
521
.PP
 
522
Paint event. 
 
523
.PP
 
524
Reimplemented from \fBQwtTextLabel\fP.
 
525
.PP
 
526
Definition at line 385 of file qwt_legend_item.cpp.
 
527
.PP
 
528
References QwtTextLabel::drawContents(), drawIdentifier(), and QwtTextLabel::margin().
 
529
.SS "void QwtLegendItem::mousePressEvent (QMouseEvent *)\fC [protected, virtual]\fP"
 
530
.PP
 
531
Handle mouse press events. 
 
532
.PP
 
533
Definition at line 428 of file qwt_legend_item.cpp.
 
534
.PP
 
535
References isDown(), and setDown().
 
536
.SS "void QwtLegendItem::mouseReleaseEvent (QMouseEvent *)\fC [protected, virtual]\fP"
 
537
.PP
 
538
Handle mouse release events. 
 
539
.PP
 
540
Definition at line 451 of file qwt_legend_item.cpp.
 
541
.PP
 
542
References setDown().
 
543
.SS "void QwtLegendItem::keyPressEvent (QKeyEvent *)\fC [protected, virtual]\fP"
 
544
.PP
 
545
Handle key press events. 
 
546
.PP
 
547
Definition at line 473 of file qwt_legend_item.cpp.
 
548
.PP
 
549
References isDown(), and setDown().
 
550
.SS "void QwtLegendItem::keyReleaseEvent (QKeyEvent *)\fC [protected, virtual]\fP"
 
551
.PP
 
552
Handle key release events. 
 
553
.PP
 
554
Definition at line 499 of file qwt_legend_item.cpp.
 
555
.PP
 
556
References setDown().
 
557
.SS "void QwtLegendItem::drawText (QPainter *, const QRect &)\fC [protected, virtual]\fP"
 
558
.PP
 
559
Redraw the text. 
 
560
.PP
 
561
Reimplemented from \fBQwtTextLabel\fP.
 
562
.PP
 
563
Definition at line 587 of file qwt_legend_item.cpp.
 
564
.PP
 
565
References QwtTextLabel::drawText().
 
566
 
 
567
.SH "Author"
 
568
.PP 
 
569
Generated automatically by Doxygen for Qwt User's Guide from the source code.