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

« back to all changes in this revision

Viewing changes to qwt-5.1.0/doc/man/man3/QwtPlotPicker.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "QwtPlotPicker" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotPicker \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtPicker\fP.
10
 
.PP
11
 
Inherited by \fBQwtPlotZoomer\fP.
12
 
.PP
13
 
.SH "Detailed Description"
14
 
.PP 
15
 
\fBQwtPlotPicker\fP provides selections on a plot canvas. 
16
 
 
17
 
\fBQwtPlotPicker\fP is a \fBQwtPicker\fP tailored for selections on a plot canvas. It is set to a x-Axis and y-Axis and translates all pixel coordinates into this coodinate system. 
18
 
.PP
19
 
Definition at line 29 of file qwt_plot_picker.h.
20
 
.SS "Signals"
21
 
 
22
 
.in +1c
23
 
.ti -1c
24
 
.RI "void \fBselected\fP (const \fBQwtDoublePoint\fP &pos)"
25
 
.br
26
 
.ti -1c
27
 
.RI "void \fBselected\fP (const \fBQwtDoubleRect\fP &rect)"
28
 
.br
29
 
.ti -1c
30
 
.RI "void \fBselected\fP (const QwtArray< \fBQwtDoublePoint\fP > &pa)"
31
 
.br
32
 
.ti -1c
33
 
.RI "void \fBappended\fP (const \fBQwtDoublePoint\fP &pos)"
34
 
.br
35
 
.ti -1c
36
 
.RI "void \fBmoved\fP (const \fBQwtDoublePoint\fP &pos)"
37
 
.br
38
 
.in -1c
39
 
.SS "Public Member Functions"
40
 
 
41
 
.in +1c
42
 
.ti -1c
43
 
.RI "\fBQwtPlotPicker\fP (\fBQwtPlotCanvas\fP *)"
44
 
.br
45
 
.ti -1c
46
 
.RI "\fBQwtPlotPicker\fP (int xAxis, int yAxis, \fBQwtPlotCanvas\fP *)"
47
 
.br
48
 
.ti -1c
49
 
.RI "\fBQwtPlotPicker\fP (int xAxis, int yAxis, int selectionFlags, \fBRubberBand\fP rubberBand, \fBDisplayMode\fP trackerMode, \fBQwtPlotCanvas\fP *)"
50
 
.br
51
 
.ti -1c
52
 
.RI "virtual void \fBsetAxis\fP (int xAxis, int yAxis)"
53
 
.br
54
 
.ti -1c
55
 
.RI "int \fBxAxis\fP () const"
56
 
.br
57
 
.ti -1c
58
 
.RI "int \fByAxis\fP () const"
59
 
.br
60
 
.ti -1c
61
 
.RI "\fBQwtPlot\fP * \fBplot\fP ()"
62
 
.br
63
 
.ti -1c
64
 
.RI "const \fBQwtPlot\fP * \fBplot\fP () const"
65
 
.br
66
 
.ti -1c
67
 
.RI "\fBQwtPlotCanvas\fP * \fBcanvas\fP ()"
68
 
.br
69
 
.ti -1c
70
 
.RI "const \fBQwtPlotCanvas\fP * \fBcanvas\fP () const"
71
 
.br
72
 
.in -1c
73
 
.SS "Protected Member Functions"
74
 
 
75
 
.in +1c
76
 
.ti -1c
77
 
.RI "\fBQwtDoubleRect\fP \fBscaleRect\fP () const"
78
 
.br
79
 
.ti -1c
80
 
.RI "\fBQwtDoubleRect\fP \fBinvTransform\fP (const QRect &) const "
81
 
.br
82
 
.ti -1c
83
 
.RI "QRect \fBtransform\fP (const \fBQwtDoubleRect\fP &) const"
84
 
.br
85
 
.ti -1c
86
 
.RI "\fBQwtDoublePoint\fP \fBinvTransform\fP (const QPoint &) const"
87
 
.br
88
 
.ti -1c
89
 
.RI "QPoint \fBtransform\fP (const \fBQwtDoublePoint\fP &) const"
90
 
.br
91
 
.ti -1c
92
 
.RI "virtual \fBQwtText\fP \fBtrackerText\fP (const QPoint &) const"
93
 
.br
94
 
.ti -1c
95
 
.RI "virtual \fBQwtText\fP \fBtrackerText\fP (const \fBQwtDoublePoint\fP &) const"
96
 
.br
97
 
.ti -1c
98
 
.RI "virtual void \fBmove\fP (const QPoint &)"
99
 
.br
100
 
.ti -1c
101
 
.RI "virtual void \fBappend\fP (const QPoint &)"
102
 
.br
103
 
.ti -1c
104
 
.RI "virtual bool \fBend\fP (bool ok=true)"
105
 
.br
106
 
.in -1c
107
 
.SH "Constructor & Destructor Documentation"
108
 
.PP 
109
 
.SS "QwtPlotPicker::QwtPlotPicker (\fBQwtPlotCanvas\fP * canvas)\fC [explicit]\fP"
110
 
.PP
111
 
Create a plot picker. 
112
 
.PP
113
 
The picker is set to those x- and y-axis of the plot that are enabled. If both or no x-axis are enabled, the picker is set to QwtPlot::xBottom. If both or no y-axis are enabled, it is set to QwtPlot::yLeft.
114
 
.PP
115
 
\fBParameters:\fP
116
 
.RS 4
117
 
\fIcanvas\fP Plot canvas to observe, also the parent object
118
 
.RE
119
 
.PP
120
 
\fBSee also:\fP
121
 
.RS 4
122
 
\fBQwtPlot::autoReplot()\fP, \fBQwtPlot::replot()\fP, \fBQwtPlotPicker::scaleRect()\fP 
123
 
.RE
124
 
.PP
125
 
 
126
 
.PP
127
 
Definition at line 32 of file qwt_plot_picker.cpp.
128
 
.PP
129
 
References QwtPlot::axisEnabled(), canvas(), plot(), setAxis(), xAxis(), and yAxis().
130
 
.SS "QwtPlotPicker::QwtPlotPicker (int xAxis, int yAxis, \fBQwtPlotCanvas\fP * canvas)\fC [explicit]\fP"
131
 
.PP
132
 
Create a plot picker
133
 
.PP
134
 
\fBParameters:\fP
135
 
.RS 4
136
 
\fIxAxis\fP Set the x axis of the picker 
137
 
.br
138
 
\fIyAxis\fP Set the y axis of the picker 
139
 
.br
140
 
\fIcanvas\fP Plot canvas to observe, also the parent object
141
 
.RE
142
 
.PP
143
 
\fBSee also:\fP
144
 
.RS 4
145
 
\fBQwtPlot::autoReplot()\fP, \fBQwtPlot::replot()\fP, \fBQwtPlotPicker::scaleRect()\fP 
146
 
.RE
147
 
.PP
148
 
 
149
 
.PP
150
 
Definition at line 70 of file qwt_plot_picker.cpp.
151
 
.SS "QwtPlotPicker::QwtPlotPicker (int xAxis, int yAxis, int selectionFlags, \fBRubberBand\fP rubberBand, \fBDisplayMode\fP trackerMode, \fBQwtPlotCanvas\fP * canvas)\fC [explicit]\fP"
152
 
.PP
153
 
Create a plot picker
154
 
.PP
155
 
\fBParameters:\fP
156
 
.RS 4
157
 
\fIxAxis\fP X axis of the picker 
158
 
.br
159
 
\fIyAxis\fP Y axis of the picker 
160
 
.br
161
 
\fIselectionFlags\fP Or'd value of SelectionType, RectSelectionType and SelectionMode 
162
 
.br
163
 
\fIrubberBand\fP Rubberband style 
164
 
.br
165
 
\fItrackerMode\fP Tracker mode 
166
 
.br
167
 
\fIcanvas\fP Plot canvas to observe, also the parent object
168
 
.RE
169
 
.PP
170
 
\fBSee also:\fP
171
 
.RS 4
172
 
\fBQwtPicker\fP, \fBQwtPicker::setSelectionFlags()\fP, \fBQwtPicker::setRubberBand()\fP, \fBQwtPicker::setTrackerMode\fP
173
 
.PP
174
 
\fBQwtPlot::autoReplot()\fP, \fBQwtPlot::replot()\fP, \fBQwtPlotPicker::scaleRect()\fP 
175
 
.RE
176
 
.PP
177
 
 
178
 
.PP
179
 
Definition at line 93 of file qwt_plot_picker.cpp.
180
 
.SH "Member Function Documentation"
181
 
.PP 
182
 
.SS "void QwtPlotPicker::setAxis (int xAxis, int yAxis)\fC [virtual]\fP"
183
 
.PP
184
 
Set the x and y axes of the picker
185
 
.PP
186
 
\fBParameters:\fP
187
 
.RS 4
188
 
\fIxAxis\fP X axis 
189
 
.br
190
 
\fIyAxis\fP Y axis 
191
 
.RE
192
 
.PP
193
 
 
194
 
.PP
195
 
Reimplemented in \fBQwtPlotZoomer\fP.
196
 
.PP
197
 
Definition at line 169 of file qwt_plot_picker.cpp.
198
 
.PP
199
 
References plot().
200
 
.PP
201
 
Referenced by QwtPlotPicker(), and QwtPlotZoomer::setAxis().
202
 
.SS "int QwtPlotPicker::xAxis () const"
203
 
.PP
204
 
Return x axis. 
205
 
.PP
206
 
Definition at line 183 of file qwt_plot_picker.cpp.
207
 
.PP
208
 
Referenced by QwtPlotPicker(), QwtPlotZoomer::rescale(), scaleRect(), and QwtPlotZoomer::setAxis().
209
 
.SS "int QwtPlotPicker::yAxis () const"
210
 
.PP
211
 
Return y axis. 
212
 
.PP
213
 
Definition at line 189 of file qwt_plot_picker.cpp.
214
 
.PP
215
 
Referenced by QwtPlotPicker(), QwtPlotZoomer::rescale(), scaleRect(), and QwtPlotZoomer::setAxis().
216
 
.SS "\fBQwtPlot\fP * QwtPlotPicker::plot ()"
217
 
.PP
218
 
Return plot widget, containing the observed plot canvas. 
219
 
.PP
220
 
Definition at line 119 of file qwt_plot_picker.cpp.
221
 
.PP
222
 
References canvas().
223
 
.PP
224
 
Referenced by QwtPlotZoomer::end(), end(), invTransform(), QwtPlotPicker(), QwtPlotZoomer::rescale(), scaleRect(), setAxis(), QwtPlotZoomer::setZoomBase(), and transform().
225
 
.SS "const \fBQwtPlot\fP * QwtPlotPicker::plot () const"
226
 
.PP
227
 
Return plot widget, containing the observed plot canvas. 
228
 
.PP
229
 
Definition at line 133 of file qwt_plot_picker.cpp.
230
 
.SS "\fBQwtPlotCanvas\fP * QwtPlotPicker::canvas ()"
231
 
.PP
232
 
Return observed plot canvas. 
233
 
.PP
234
 
Definition at line 103 of file qwt_plot_picker.cpp.
235
 
.PP
236
 
References QwtPicker::parentWidget().
237
 
.PP
238
 
Referenced by plot(), QwtPlotPicker(), and QwtPlotZoomer::QwtPlotZoomer().
239
 
.SS "const \fBQwtPlotCanvas\fP * QwtPlotPicker::canvas () const"
240
 
.PP
241
 
Return Observed plot canvas. 
242
 
.PP
243
 
Definition at line 113 of file qwt_plot_picker.cpp.
244
 
.SS "void QwtPlotPicker::selected (const \fBQwtDoublePoint\fP & pos)\fC [signal]\fP"
245
 
.PP
246
 
A signal emitted in case of \fBselectionFlags()\fP & PointSelection. 
247
 
.PP
248
 
\fBParameters:\fP
249
 
.RS 4
250
 
\fIpos\fP Selected point 
251
 
.RE
252
 
.PP
253
 
 
254
 
.PP
255
 
Referenced by end().
256
 
.SS "void QwtPlotPicker::selected (const \fBQwtDoubleRect\fP & rect)\fC [signal]\fP"
257
 
.PP
258
 
A signal emitted in case of \fBselectionFlags()\fP & RectSelection. 
259
 
.PP
260
 
\fBParameters:\fP
261
 
.RS 4
262
 
\fIrect\fP Selected rectangle 
263
 
.RE
264
 
.PP
265
 
 
266
 
.SS "void QwtPlotPicker::selected (const QwtArray< \fBQwtDoublePoint\fP > & pa)\fC [signal]\fP"
267
 
.PP
268
 
A signal emitting the selected points, at the end of a selection.
269
 
.PP
270
 
\fBParameters:\fP
271
 
.RS 4
272
 
\fIpa\fP Selected points 
273
 
.RE
274
 
.PP
275
 
 
276
 
.SS "void QwtPlotPicker::appended (const \fBQwtDoublePoint\fP & pos)\fC [signal]\fP"
277
 
.PP
278
 
A signal emitted when a point has been appended to the selection
279
 
.PP
280
 
\fBParameters:\fP
281
 
.RS 4
282
 
\fIpos\fP Position of the appended point. 
283
 
.RE
284
 
.PP
285
 
\fBSee also:\fP
286
 
.RS 4
287
 
\fBappend()\fP. \fBmoved()\fP 
288
 
.RE
289
 
.PP
290
 
 
291
 
.PP
292
 
Referenced by append().
293
 
.SS "void QwtPlotPicker::moved (const \fBQwtDoublePoint\fP & pos)\fC [signal]\fP"
294
 
.PP
295
 
A signal emitted whenever the last appended point of the selection has been moved.
296
 
.PP
297
 
\fBParameters:\fP
298
 
.RS 4
299
 
\fIpos\fP Position of the moved last point of the selection. 
300
 
.RE
301
 
.PP
302
 
\fBSee also:\fP
303
 
.RS 4
304
 
\fBmove()\fP, \fBappended()\fP 
305
 
.RE
306
 
.PP
307
 
 
308
 
.PP
309
 
Referenced by move().
310
 
.SS "\fBQwtDoubleRect\fP QwtPlotPicker::scaleRect () const\fC [protected]\fP"
311
 
.PP
312
 
Return normalized bounding rect of the axes
313
 
.PP
314
 
\fBSee also:\fP
315
 
.RS 4
316
 
\fBQwtPlot::autoReplot()\fP, \fBQwtPlot::replot()\fP. 
317
 
.RE
318
 
.PP
319
 
 
320
 
.PP
321
 
Definition at line 143 of file qwt_plot_picker.cpp.
322
 
.PP
323
 
References QwtPlot::axisScaleDiv(), QwtScaleDiv::lBound(), plot(), QwtScaleDiv::range(), xAxis(), and yAxis().
324
 
.PP
325
 
Referenced by QwtPlotZoomer::rescale(), QwtPlotZoomer::setAxis(), and QwtPlotZoomer::setZoomBase().
326
 
.SS "\fBQwtDoubleRect\fP QwtPlotPicker::invTransform (const QRect & rect) const\fC [protected]\fP"
327
 
.PP
328
 
Translate a rectangle from pixel into plot coordinates
329
 
.PP
330
 
\fBReturns:\fP
331
 
.RS 4
332
 
Rectangle in plot coordinates 
333
 
.RE
334
 
.PP
335
 
\fBSee also:\fP
336
 
.RS 4
337
 
\fBQwtPlotPicker::transform()\fP 
338
 
.RE
339
 
.PP
340
 
 
341
 
.PP
342
 
Definition at line 332 of file qwt_plot_picker.cpp.
343
 
.PP
344
 
References QwtPlot::canvasMap(), QwtScaleMap::invTransform(), and plot().
345
 
.PP
346
 
Referenced by append(), QwtPlotZoomer::end(), end(), move(), and trackerText().
347
 
.SS "QRect QwtPlotPicker::transform (const \fBQwtDoubleRect\fP & rect) const\fC [protected]\fP"
348
 
.PP
349
 
Translate a rectangle from plot into pixel coordinates 
350
 
.PP
351
 
\fBReturns:\fP
352
 
.RS 4
353
 
Rectangle in pixel coordinates 
354
 
.RE
355
 
.PP
356
 
\fBSee also:\fP
357
 
.RS 4
358
 
\fBQwtPlotPicker::invTransform()\fP 
359
 
.RE
360
 
.PP
361
 
 
362
 
.PP
363
 
Definition at line 351 of file qwt_plot_picker.cpp.
364
 
.PP
365
 
References QwtPlot::canvasMap(), plot(), and QwtScaleMap::transform().
366
 
.SS "\fBQwtDoublePoint\fP QwtPlotPicker::invTransform (const QPoint & pos) const\fC [protected]\fP"
367
 
.PP
368
 
Translate a point from pixel into plot coordinates 
369
 
.PP
370
 
\fBReturns:\fP
371
 
.RS 4
372
 
Point in plot coordinates 
373
 
.RE
374
 
.PP
375
 
\fBSee also:\fP
376
 
.RS 4
377
 
\fBQwtPlotPicker::transform()\fP 
378
 
.RE
379
 
.PP
380
 
 
381
 
.PP
382
 
Definition at line 369 of file qwt_plot_picker.cpp.
383
 
.PP
384
 
References QwtPlot::canvasMap(), QwtScaleMap::invTransform(), and plot().
385
 
.SS "QPoint QwtPlotPicker::transform (const \fBQwtDoublePoint\fP & pos) const\fC [protected]\fP"
386
 
.PP
387
 
Translate a point from plot into pixel coordinates 
388
 
.PP
389
 
\fBReturns:\fP
390
 
.RS 4
391
 
Point in pixel coordinates 
392
 
.RE
393
 
.PP
394
 
\fBSee also:\fP
395
 
.RS 4
396
 
\fBQwtPlotPicker::invTransform()\fP 
397
 
.RE
398
 
.PP
399
 
 
400
 
.PP
401
 
Definition at line 385 of file qwt_plot_picker.cpp.
402
 
.PP
403
 
References QwtPlot::canvasMap(), plot(), and QwtScaleMap::transform().
404
 
.SS "\fBQwtText\fP QwtPlotPicker::trackerText (const QPoint & pos) const\fC [protected, virtual]\fP"
405
 
.PP
406
 
Translate a pixel position into a position string
407
 
.PP
408
 
\fBParameters:\fP
409
 
.RS 4
410
 
\fIpos\fP Position in pixel coordinates 
411
 
.RE
412
 
.PP
413
 
\fBReturns:\fP
414
 
.RS 4
415
 
Position string 
416
 
.RE
417
 
.PP
418
 
 
419
 
.PP
420
 
Reimplemented from \fBQwtPicker\fP.
421
 
.PP
422
 
Definition at line 200 of file qwt_plot_picker.cpp.
423
 
.PP
424
 
References invTransform().
425
 
.SS "\fBQwtText\fP QwtPlotPicker::trackerText (const \fBQwtDoublePoint\fP & pos) const\fC [protected, virtual]\fP"
426
 
.PP
427
 
Translate a position into a position string. 
428
 
.PP
429
 
In case of HLineRubberBand the label is the value of the y position, in case of VLineRubberBand the value of the x position. Otherwise the label contains x and y position separated by a ',' .
430
 
.PP
431
 
The format for the double to string conversion is '%.4f'.
432
 
.PP
433
 
\fBParameters:\fP
434
 
.RS 4
435
 
\fIpos\fP Position 
436
 
.RE
437
 
.PP
438
 
\fBReturns:\fP
439
 
.RS 4
440
 
Position string 
441
 
.RE
442
 
.PP
443
 
 
444
 
.PP
445
 
Definition at line 217 of file qwt_plot_picker.cpp.
446
 
.PP
447
 
References QwtPicker::rubberBand().
448
 
.SS "void QwtPlotPicker::move (const QPoint & pos)\fC [protected, virtual]\fP"
449
 
.PP
450
 
Move the last point of the selection
451
 
.PP
452
 
\fBParameters:\fP
453
 
.RS 4
454
 
\fIpos\fP New position 
455
 
.RE
456
 
.PP
457
 
\fBSee also:\fP
458
 
.RS 4
459
 
\fBisActive\fP, \fBbegin()\fP, \fBend()\fP, \fBappend()\fP
460
 
.RE
461
 
.PP
462
 
\fBNote:\fP
463
 
.RS 4
464
 
The \fBmoved(const QPoint &)\fP, moved(const QDoublePoint &) signals are emitted. 
465
 
.RE
466
 
.PP
467
 
 
468
 
.PP
469
 
Reimplemented from \fBQwtPicker\fP.
470
 
.PP
471
 
Definition at line 259 of file qwt_plot_picker.cpp.
472
 
.PP
473
 
References invTransform(), QwtPicker::move(), and moved().
474
 
.SS "void QwtPlotPicker::append (const QPoint & pos)\fC [protected, virtual]\fP"
475
 
.PP
476
 
Append a point to the selection and update rubberband and tracker.
477
 
.PP
478
 
\fBParameters:\fP
479
 
.RS 4
480
 
\fIpos\fP Additional point 
481
 
.RE
482
 
.PP
483
 
\fBSee also:\fP
484
 
.RS 4
485
 
\fBisActive\fP, \fBbegin()\fP, \fBend()\fP, \fBmove()\fP, \fBappended()\fP
486
 
.RE
487
 
.PP
488
 
\fBNote:\fP
489
 
.RS 4
490
 
The \fBappended(const QPoint &)\fP, appended(const QDoublePoint &) signals are emitted. 
491
 
.RE
492
 
.PP
493
 
 
494
 
.PP
495
 
Reimplemented from \fBQwtPicker\fP.
496
 
.PP
497
 
Definition at line 244 of file qwt_plot_picker.cpp.
498
 
.PP
499
 
References QwtPicker::append(), appended(), and invTransform().
500
 
.SS "bool QwtPlotPicker::end (bool ok = \fCtrue\fP)\fC [protected, virtual]\fP"
501
 
.PP
502
 
Close a selection setting the state to inactive.
503
 
.PP
504
 
\fBParameters:\fP
505
 
.RS 4
506
 
\fIok\fP If true, complete the selection and emit selected signals otherwise discard the selection. 
507
 
.RE
508
 
.PP
509
 
\fBReturns:\fP
510
 
.RS 4
511
 
true if the selection is accepted, false otherwise 
512
 
.RE
513
 
.PP
514
 
 
515
 
.PP
516
 
Reimplemented from \fBQwtPicker\fP.
517
 
.PP
518
 
Reimplemented in \fBQwtPlotZoomer\fP.
519
 
.PP
520
 
Definition at line 273 of file qwt_plot_picker.cpp.
521
 
.PP
522
 
References QwtPicker::end(), invTransform(), plot(), selected(), QwtPicker::selection(), and QwtPicker::selectionFlags().
523
 
.PP
524
 
Referenced by QwtPlotZoomer::end().
525
 
 
526
 
.SH "Author"
527
 
.PP 
528
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.