← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.0/doc/man/man3/QwtPlotLayout.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:
qwt-5.1.0/doc/man/man3/QwtPlotLayout.3
1
 
.TH "QwtPlotLayout" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotLayout \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
.SH "Detailed Description"
10
 
.PP 
11
 
Layout class for \fBQwtPlot\fP. 
12
 
 
13
 
Organizes the geometry for the different \fBQwtPlot\fP components. 
14
 
.PP
15
 
Definition at line 22 of file qwt_plot_layout.h.
16
 
.SS "Public Types"
17
 
 
18
 
.in +1c
19
 
.ti -1c
20
 
.RI "enum \fBOptions\fP { \fBAlignScales\fP =  1, \fBIgnoreScrollbars\fP =  2, \fBIgnoreFrames\fP =  4, \fBIgnoreMargin\fP =  8, \fBIgnoreLegend\fP =  16, \fBPrintMargin\fP =  1, \fBPrintTitle\fP =  2, \fBPrintLegend\fP =  4, \fBPrintGrid\fP =  8, \fBPrintBackground\fP =  16, \fBPrintFrameWithScales\fP =  32, \fBPrintAll\fP =  ~PrintFrameWithScales }"
21
 
.br
22
 
.in -1c
23
 
.SS "Public Member Functions"
24
 
 
25
 
.in +1c
26
 
.ti -1c
27
 
.RI "\fBQwtPlotLayout\fP ()"
28
 
.br
29
 
.ti -1c
30
 
.RI "virtual \fB~QwtPlotLayout\fP ()"
31
 
.br
32
 
.ti -1c
33
 
.RI "void \fBsetMargin\fP (int)"
34
 
.br
35
 
.ti -1c
36
 
.RI "int \fBmargin\fP () const"
37
 
.br
38
 
.ti -1c
39
 
.RI "void \fBsetCanvasMargin\fP (int margin, int axis=-1)"
40
 
.br
41
 
.ti -1c
42
 
.RI "int \fBcanvasMargin\fP (int axis) const"
43
 
.br
44
 
.ti -1c
45
 
.RI "void \fBsetAlignCanvasToScales\fP (bool)"
46
 
.br
47
 
.ti -1c
48
 
.RI "bool \fBalignCanvasToScales\fP () const"
49
 
.br
50
 
.ti -1c
51
 
.RI "void \fBsetSpacing\fP (int)"
52
 
.br
53
 
.ti -1c
54
 
.RI "int \fBspacing\fP () const"
55
 
.br
56
 
.ti -1c
57
 
.RI "void \fBsetLegendPosition\fP (\fBQwtPlot::LegendPosition\fP pos, double ratio)"
58
 
.br
59
 
.ti -1c
60
 
.RI "void \fBsetLegendPosition\fP (\fBQwtPlot::LegendPosition\fP pos)"
61
 
.br
62
 
.ti -1c
63
 
.RI "\fBQwtPlot::LegendPosition\fP \fBlegendPosition\fP () const"
64
 
.br
65
 
.ti -1c
66
 
.RI "void \fBsetLegendRatio\fP (double ratio)"
67
 
.br
68
 
.ti -1c
69
 
.RI "double \fBlegendRatio\fP () const"
70
 
.br
71
 
.ti -1c
72
 
.RI "virtual QSize \fBminimumSizeHint\fP (const \fBQwtPlot\fP *) const"
73
 
.br
74
 
.ti -1c
75
 
.RI "virtual void \fBactivate\fP (const \fBQwtPlot\fP *, const QRect &rect, int options=0)"
76
 
.br
77
 
.ti -1c
78
 
.RI "virtual void \fBinvalidate\fP ()"
79
 
.br
80
 
.ti -1c
81
 
.RI "const QRect & \fBtitleRect\fP () const"
82
 
.br
83
 
.ti -1c
84
 
.RI "const QRect & \fBlegendRect\fP () const"
85
 
.br
86
 
.ti -1c
87
 
.RI "const QRect & \fBscaleRect\fP (int axis) const"
88
 
.br
89
 
.ti -1c
90
 
.RI "const QRect & \fBcanvasRect\fP () const"
91
 
.br
92
 
.in -1c
93
 
.SS "Protected Member Functions"
94
 
 
95
 
.in +1c
96
 
.ti -1c
97
 
.RI "QRect \fBlayoutLegend\fP (int options, const QRect &) const"
98
 
.br
99
 
.ti -1c
100
 
.RI "QRect \fBalignLegend\fP (const QRect &canvasRect, const QRect &legendRect) const"
101
 
.br
102
 
.ti -1c
103
 
.RI "void \fBexpandLineBreaks\fP (int options, const QRect &rect, int &dimTitle, int dimAxes[QwtPlot::axisCnt]) const"
104
 
.br
105
 
.ti -1c
106
 
.RI "void \fBalignScales\fP (int options, QRect &canvasRect, QRect scaleRect[QwtPlot::axisCnt]) const"
107
 
.br
108
 
.in -1c
109
 
.SH "Constructor & Destructor Documentation"
110
 
.PP 
111
 
.SS "QwtPlotLayout::QwtPlotLayout ()\fC [explicit]\fP"
112
 
.PP
113
 
Constructor. 
114
 
.PP
115
 
Definition at line 182 of file qwt_plot_layout.cpp.
116
 
.PP
117
 
References invalidate(), setCanvasMargin(), and setLegendPosition().
118
 
.SS "QwtPlotLayout::~QwtPlotLayout ()\fC [virtual]\fP"
119
 
.PP
120
 
Destructor. 
121
 
.PP
122
 
Definition at line 193 of file qwt_plot_layout.cpp.
123
 
.SH "Member Function Documentation"
124
 
.PP 
125
 
.SS "void QwtPlotLayout::setMargin (int margin)"
126
 
.PP
127
 
Change the margin of the plot. The margin is the space around all components.
128
 
.PP
129
 
\fBParameters:\fP
130
 
.RS 4
131
 
\fImargin\fP new margin 
132
 
.RE
133
 
.PP
134
 
\fBSee also:\fP
135
 
.RS 4
136
 
\fBmargin()\fP, \fBsetSpacing()\fP, \fBQwtPlot::setMargin()\fP 
137
 
.RE
138
 
.PP
139
 
 
140
 
.PP
141
 
Definition at line 206 of file qwt_plot_layout.cpp.
142
 
.SS "int QwtPlotLayout::margin () const"
143
 
.PP
144
 
\fBReturns:\fP
145
 
.RS 4
146
 
margin 
147
 
.RE
148
 
.PP
149
 
\fBSee also:\fP
150
 
.RS 4
151
 
\fBsetMargin()\fP, \fBspacing()\fP, \fBQwtPlot::margin()\fP 
152
 
.RE
153
 
.PP
154
 
 
155
 
.PP
156
 
Definition at line 217 of file qwt_plot_layout.cpp.
157
 
.SS "void QwtPlotLayout::setCanvasMargin (int margin, int axis = \fC-1\fP)"
158
 
.PP
159
 
Change a margin of the canvas. The margin is the space above/below the scale ticks. A negative margin will be set to -1, excluding the borders of the scales.
160
 
.PP
161
 
\fBParameters:\fP
162
 
.RS 4
163
 
\fImargin\fP New margin 
164
 
.br
165
 
\fIaxis\fP One of \fBQwtPlot::Axis\fP. Specifies where the position of the margin. -1 means margin at all borders. 
166
 
.RE
167
 
.PP
168
 
\fBSee also:\fP
169
 
.RS 4
170
 
\fBcanvasMargin()\fP
171
 
.RE
172
 
.PP
173
 
\fBWarning:\fP
174
 
.RS 4
175
 
The margin will have no effect when alignCanvasToScales is true 
176
 
.RE
177
 
.PP
178
 
 
179
 
.PP
180
 
Definition at line 235 of file qwt_plot_layout.cpp.
181
 
.PP
182
 
Referenced by QwtPlotLayout().
183
 
.SS "int QwtPlotLayout::canvasMargin (int axis) const"
184
 
.PP
185
 
\fBReturns:\fP
186
 
.RS 4
187
 
Margin around the scale tick borders 
188
 
.RE
189
 
.PP
190
 
\fBSee also:\fP
191
 
.RS 4
192
 
\fBsetCanvasMargin()\fP 
193
 
.RE
194
 
.PP
195
 
 
196
 
.PP
197
 
Definition at line 253 of file qwt_plot_layout.cpp.
198
 
.PP
199
 
Referenced by QwtPlot::canvasMap(), and QwtPlot::print().
200
 
.SS "void QwtPlotLayout::setAlignCanvasToScales (bool alignCanvasToScales)"
201
 
.PP
202
 
Change the align-canvas-to-axis-scales setting. The canvas may:
203
 
.IP "\(bu" 2
204
 
extend beyond the axis scale ends to maximize its size,
205
 
.IP "\(bu" 2
206
 
align with the axis scale ends to control its size.
207
 
.PP
208
 
.PP
209
 
\fBParameters:\fP
210
 
.RS 4
211
 
\fIalignCanvasToScales\fP New align-canvas-to-axis-scales setting
212
 
.RE
213
 
.PP
214
 
\fBSee also:\fP
215
 
.RS 4
216
 
\fBsetCanvasMargin()\fP 
217
 
.RE
218
 
.PP
219
 
\fBNote:\fP
220
 
.RS 4
221
 
In this context the term 'scale' means the backbone of a scale. 
222
 
.RE
223
 
.PP
224
 
\fBWarning:\fP
225
 
.RS 4
226
 
In case of alignCanvasToScales == true canvasMargin will have no effect 
227
 
.RE
228
 
.PP
229
 
 
230
 
.PP
231
 
Definition at line 273 of file qwt_plot_layout.cpp.
232
 
.SS "bool QwtPlotLayout::alignCanvasToScales () const"
233
 
.PP
234
 
Return the align-canvas-to-axis-scales setting. The canvas may:
235
 
.IP "\(bu" 2
236
 
extend beyond the axis scale ends to maximize its size
237
 
.IP "\(bu" 2
238
 
align with the axis scale ends to control its size.
239
 
.PP
240
 
.PP
241
 
\fBReturns:\fP
242
 
.RS 4
243
 
align-canvas-to-axis-scales setting 
244
 
.RE
245
 
.PP
246
 
\fBSee also:\fP
247
 
.RS 4
248
 
\fBsetAlignCanvasToScales\fP, \fBsetCanvasMargin()\fP 
249
 
.RE
250
 
.PP
251
 
\fBNote:\fP
252
 
.RS 4
253
 
In this context the term 'scale' means the backbone of a scale. 
254
 
.RE
255
 
.PP
256
 
 
257
 
.PP
258
 
Definition at line 287 of file qwt_plot_layout.cpp.
259
 
.SS "void QwtPlotLayout::setSpacing (int spacing)"
260
 
.PP
261
 
Change the spacing of the plot. The spacing is the distance between the plot components.
262
 
.PP
263
 
\fBParameters:\fP
264
 
.RS 4
265
 
\fIspacing\fP new spacing 
266
 
.RE
267
 
.PP
268
 
\fBSee also:\fP
269
 
.RS 4
270
 
\fBsetMargin()\fP, \fBspacing()\fP 
271
 
.RE
272
 
.PP
273
 
 
274
 
.PP
275
 
Definition at line 299 of file qwt_plot_layout.cpp.
276
 
.SS "int QwtPlotLayout::spacing () const"
277
 
.PP
278
 
\fBReturns:\fP
279
 
.RS 4
280
 
spacing 
281
 
.RE
282
 
.PP
283
 
\fBSee also:\fP
284
 
.RS 4
285
 
\fBmargin()\fP, \fBsetSpacing()\fP 
286
 
.RE
287
 
.PP
288
 
 
289
 
.PP
290
 
Definition at line 308 of file qwt_plot_layout.cpp.
291
 
.SS "void QwtPlotLayout::setLegendPosition (\fBQwtPlot::LegendPosition\fP pos, double ratio)"
292
 
.PP
293
 
Specify the position of the legend. 
294
 
.PP
295
 
\fBParameters:\fP
296
 
.RS 4
297
 
\fIpos\fP The legend's position. 
298
 
.br
299
 
\fIratio\fP Ratio between legend and the bounding rect of title, canvas and axes. The legend will be shrinked if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5.
300
 
.RE
301
 
.PP
302
 
\fBSee also:\fP
303
 
.RS 4
304
 
QwtPlot::setLegendPosition() 
305
 
.RE
306
 
.PP
307
 
 
308
 
.PP
309
 
Definition at line 326 of file qwt_plot_layout.cpp.
310
 
.PP
311
 
Referenced by QwtPlotLayout(), setLegendPosition(), and setLegendRatio().
312
 
.SS "void QwtPlotLayout::setLegendPosition (\fBQwtPlot::LegendPosition\fP pos)"
313
 
.PP
314
 
Specify the position of the legend. 
315
 
.PP
316
 
\fBParameters:\fP
317
 
.RS 4
318
 
\fIpos\fP The legend's position. Valid values are \fCQwtPlot::LeftLegend\fP, \fCQwtPlot::RightLegend\fP, \fCQwtPlot::TopLegend\fP, \fCQwtPlot::BottomLegend\fP.
319
 
.RE
320
 
.PP
321
 
\fBSee also:\fP
322
 
.RS 4
323
 
QwtPlot::setLegendPosition() 
324
 
.RE
325
 
.PP
326
 
 
327
 
.PP
328
 
Definition at line 363 of file qwt_plot_layout.cpp.
329
 
.PP
330
 
References setLegendPosition().
331
 
.SS "\fBQwtPlot::LegendPosition\fP QwtPlotLayout::legendPosition () const"
332
 
.PP
333
 
\fBReturns:\fP
334
 
.RS 4
335
 
Position of the legend 
336
 
.RE
337
 
.PP
338
 
\fBSee also:\fP
339
 
.RS 4
340
 
\fBsetLegendPosition()\fP, QwtPlot::setLegendPosition(), QwtPlot::legendPosition() 
341
 
.RE
342
 
.PP
343
 
 
344
 
.PP
345
 
Definition at line 373 of file qwt_plot_layout.cpp.
346
 
.PP
347
 
Referenced by setLegendRatio().
348
 
.SS "void QwtPlotLayout::setLegendRatio (double ratio)"
349
 
.PP
350
 
Specify the relative size of the legend in the plot 
351
 
.PP
352
 
\fBParameters:\fP
353
 
.RS 4
354
 
\fIratio\fP Ratio between legend and the bounding rect of title, canvas and axes. The legend will be shrinked if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5. 
355
 
.RE
356
 
.PP
357
 
 
358
 
.PP
359
 
Definition at line 387 of file qwt_plot_layout.cpp.
360
 
.PP
361
 
References legendPosition(), and setLegendPosition().
362
 
.SS "double QwtPlotLayout::legendRatio () const"
363
 
.PP
364
 
\fBReturns:\fP
365
 
.RS 4
366
 
The relative size of the legend in the plot. 
367
 
.RE
368
 
.PP
369
 
\fBSee also:\fP
370
 
.RS 4
371
 
\fBsetLegendPosition()\fP 
372
 
.RE
373
 
.PP
374
 
 
375
 
.PP
376
 
Definition at line 396 of file qwt_plot_layout.cpp.
377
 
.SS "QSize QwtPlotLayout::minimumSizeHint (const \fBQwtPlot\fP * plot) const\fC [virtual]\fP"
378
 
.PP
379
 
Return a minimum size hint. 
380
 
.PP
381
 
\fBSee also:\fP
382
 
.RS 4
383
 
\fBQwtPlot::minimumSizeHint()\fP 
384
 
.RE
385
 
.PP
386
 
 
387
 
.PP
388
 
Definition at line 463 of file qwt_plot_layout.cpp.
389
 
.PP
390
 
References QwtPlot::axisEnabled(), QwtPlot::axisWidget(), QwtPlot::canvas(), and QwtScaleWidget::minimumSizeHint().
391
 
.SS "void QwtPlotLayout::activate (const \fBQwtPlot\fP * plot, const QRect & plotRect, int options = \fC0\fP)\fC [virtual]\fP"
392
 
.PP
393
 
Recalculate the geometry of all components. 
394
 
.PP
395
 
\fBParameters:\fP
396
 
.RS 4
397
 
\fIplot\fP Plot to be layout 
398
 
.br
399
 
\fIplotRect\fP Rect where to place the components 
400
 
.br
401
 
\fIoptions\fP Options
402
 
.RE
403
 
.PP
404
 
\fBSee also:\fP
405
 
.RS 4
406
 
\fBinvalidate()\fP, \fBtitleRect()\fP, \fBlegendRect()\fP, \fBscaleRect()\fP, \fBcanvasRect()\fP 
407
 
.RE
408
 
.PP
409
 
 
410
 
.PP
411
 
Definition at line 1022 of file qwt_plot_layout.cpp.
412
 
.PP
413
 
References alignLegend(), alignScales(), expandLineBreaks(), invalidate(), QwtLegend::isEmpty(), layoutLegend(), QwtPlot::legend(), and scaleRect().
414
 
.SS "void QwtPlotLayout::invalidate ()\fC [virtual]\fP"
415
 
.PP
416
 
Invalidate the geometry of all components. 
417
 
.PP
418
 
\fBSee also:\fP
419
 
.RS 4
420
 
\fBactivate()\fP 
421
 
.RE
422
 
.PP
423
 
 
424
 
.PP
425
 
Definition at line 451 of file qwt_plot_layout.cpp.
426
 
.PP
427
 
Referenced by activate(), and QwtPlotLayout().
428
 
.SS "const QRect & QwtPlotLayout::titleRect () const"
429
 
.PP
430
 
\fBReturns:\fP
431
 
.RS 4
432
 
Geometry for the title 
433
 
.RE
434
 
.PP
435
 
\fBSee also:\fP
436
 
.RS 4
437
 
\fBactivate()\fP, \fBinvalidate()\fP 
438
 
.RE
439
 
.PP
440
 
 
441
 
.PP
442
 
Definition at line 406 of file qwt_plot_layout.cpp.
443
 
.SS "const QRect & QwtPlotLayout::legendRect () const"
444
 
.PP
445
 
\fBReturns:\fP
446
 
.RS 4
447
 
Geometry for the legend 
448
 
.RE
449
 
.PP
450
 
\fBSee also:\fP
451
 
.RS 4
452
 
\fBactivate()\fP, \fBinvalidate()\fP 
453
 
.RE
454
 
.PP
455
 
 
456
 
.PP
457
 
Definition at line 416 of file qwt_plot_layout.cpp.
458
 
.PP
459
 
Referenced by layoutLegend().
460
 
.SS "const QRect & QwtPlotLayout::scaleRect (int axis) const"
461
 
.PP
462
 
\fBParameters:\fP
463
 
.RS 4
464
 
\fIaxis\fP Axis index 
465
 
.RE
466
 
.PP
467
 
\fBReturns:\fP
468
 
.RS 4
469
 
Geometry for the scale 
470
 
.RE
471
 
.PP
472
 
\fBSee also:\fP
473
 
.RS 4
474
 
\fBactivate()\fP, \fBinvalidate()\fP 
475
 
.RE
476
 
.PP
477
 
 
478
 
.PP
479
 
Definition at line 427 of file qwt_plot_layout.cpp.
480
 
.PP
481
 
Referenced by activate(), alignScales(), and QwtPlot::print().
482
 
.SS "const QRect & QwtPlotLayout::canvasRect () const"
483
 
.PP
484
 
\fBReturns:\fP
485
 
.RS 4
486
 
Geometry for the canvas 
487
 
.RE
488
 
.PP
489
 
\fBSee also:\fP
490
 
.RS 4
491
 
\fBactivate()\fP, \fBinvalidate()\fP 
492
 
.RE
493
 
.PP
494
 
 
495
 
.PP
496
 
Definition at line 442 of file qwt_plot_layout.cpp.
497
 
.PP
498
 
Referenced by QwtPlot::print().
499
 
.SS "QRect QwtPlotLayout::layoutLegend (int options, const QRect & rect) const\fC [protected]\fP"
500
 
.PP
501
 
Find the geometry for the legend 
502
 
.PP
503
 
\fBParameters:\fP
504
 
.RS 4
505
 
\fIoptions\fP Options how to layout the legend 
506
 
.br
507
 
\fIrect\fP Rectangle where to place the legend 
508
 
.RE
509
 
.PP
510
 
\fBReturns:\fP
511
 
.RS 4
512
 
Geometry for the legend 
513
 
.RE
514
 
.PP
515
 
 
516
 
.PP
517
 
Definition at line 647 of file qwt_plot_layout.cpp.
518
 
.PP
519
 
References legendRect().
520
 
.PP
521
 
Referenced by activate().
522
 
.SS "QRect QwtPlotLayout::alignLegend (const QRect & canvasRect, const QRect & legendRect) const\fC [protected]\fP"
523
 
.PP
524
 
Align the legend to the canvas 
525
 
.PP
526
 
\fBParameters:\fP
527
 
.RS 4
528
 
\fIcanvasRect\fP Geometry of the canvas 
529
 
.br
530
 
\fIlegendRect\fP Maximum geometry for the legend 
531
 
.RE
532
 
.PP
533
 
\fBReturns:\fP
534
 
.RS 4
535
 
Geometry for the aligned legend 
536
 
.RE
537
 
.PP
538
 
 
539
 
.PP
540
 
Definition at line 708 of file qwt_plot_layout.cpp.
541
 
.PP
542
 
Referenced by activate().
543
 
.SS "void QwtPlotLayout::expandLineBreaks (int options, const QRect & rect, int & dimTitle, int dimAxis[QwtPlot::axisCnt]) const\fC [protected]\fP"
544
 
.PP
545
 
Expand all line breaks in text labels, and calculate the height of their widgets in orientation of the text.
546
 
.PP
547
 
\fBParameters:\fP
548
 
.RS 4
549
 
\fIoptions\fP Options how to layout the legend 
550
 
.br
551
 
\fIrect\fP Bounding rect for title, axes and canvas. 
552
 
.br
553
 
\fIdimTitle\fP Expanded height of the title widget 
554
 
.br
555
 
\fIdimAxis\fP Expanded heights of the axis in axis orientation. 
556
 
.RE
557
 
.PP
558
 
 
559
 
.PP
560
 
Definition at line 743 of file qwt_plot_layout.cpp.
561
 
.PP
562
 
Referenced by activate().
563
 
.SS "void QwtPlotLayout::alignScales (int options, QRect & canvasRect, QRect scaleRect[QwtPlot::axisCnt]) const\fC [protected]\fP"
564
 
.PP
565
 
Align the ticks of the axis to the canvas borders using the empty corners. 
566
 
.PP
567
 
Definition at line 849 of file qwt_plot_layout.cpp.
568
 
.PP
569
 
References scaleRect().
570
 
.PP
571
 
Referenced by activate().
572
 
 
573
 
.SH "Author"
574
 
.PP 
575
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.