← 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/QwtPlotGrid.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/QwtPlotGrid.3
1
 
.TH "QwtPlotGrid" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotGrid \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtPlotItem\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
A class which draws a coordinate grid. 
14
 
 
15
 
The \fBQwtPlotGrid\fP class can be used to draw a coordinate grid. A coordinate grid consists of major and minor vertical and horizontal gridlines. The locations of the gridlines are determined by the X and Y scale divisions which can be assigned with \fBsetXDiv()\fP and \fBsetYDiv()\fP. The \fBdraw()\fP member draws the grid within a bounding rectangle. 
16
 
.PP
17
 
Definition at line 34 of file qwt_plot_grid.h.
18
 
.SS "Public Member Functions"
19
 
 
20
 
.in +1c
21
 
.ti -1c
22
 
.RI "\fBQwtPlotGrid\fP ()"
23
 
.br
24
 
.ti -1c
25
 
.RI "virtual \fB~QwtPlotGrid\fP ()"
26
 
.br
27
 
.ti -1c
28
 
.RI "virtual int \fBrtti\fP () const"
29
 
.br
30
 
.ti -1c
31
 
.RI "void \fBenableX\fP (bool tf)"
32
 
.br
33
 
.ti -1c
34
 
.RI "bool \fBxEnabled\fP () const"
35
 
.br
36
 
.ti -1c
37
 
.RI "void \fBenableY\fP (bool tf)"
38
 
.br
39
 
.ti -1c
40
 
.RI "bool \fByEnabled\fP () const"
41
 
.br
42
 
.ti -1c
43
 
.RI "void \fBenableXMin\fP (bool tf)"
44
 
.br
45
 
.ti -1c
46
 
.RI "bool \fBxMinEnabled\fP () const"
47
 
.br
48
 
.ti -1c
49
 
.RI "void \fBenableYMin\fP (bool tf)"
50
 
.br
51
 
.ti -1c
52
 
.RI "bool \fByMinEnabled\fP () const"
53
 
.br
54
 
.ti -1c
55
 
.RI "void \fBsetXDiv\fP (const \fBQwtScaleDiv\fP &sx)"
56
 
.br
57
 
.ti -1c
58
 
.RI "const \fBQwtScaleDiv\fP & \fBxScaleDiv\fP () const"
59
 
.br
60
 
.ti -1c
61
 
.RI "void \fBsetYDiv\fP (const \fBQwtScaleDiv\fP &sy)"
62
 
.br
63
 
.ti -1c
64
 
.RI "const \fBQwtScaleDiv\fP & \fByScaleDiv\fP () const"
65
 
.br
66
 
.ti -1c
67
 
.RI "void \fBsetPen\fP (const QPen &p)"
68
 
.br
69
 
.ti -1c
70
 
.RI "void \fBsetMajPen\fP (const QPen &p)"
71
 
.br
72
 
.ti -1c
73
 
.RI "const QPen & \fBmajPen\fP () const"
74
 
.br
75
 
.ti -1c
76
 
.RI "void \fBsetMinPen\fP (const QPen &p)"
77
 
.br
78
 
.ti -1c
79
 
.RI "const QPen & \fBminPen\fP () const"
80
 
.br
81
 
.ti -1c
82
 
.RI "virtual void \fBdraw\fP (QPainter *p, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &rect) const"
83
 
.br
84
 
.ti -1c
85
 
.RI "virtual void \fBupdateScaleDiv\fP (const \fBQwtScaleDiv\fP &xMap, const \fBQwtScaleDiv\fP &yMap)"
86
 
.br
87
 
.in -1c
88
 
.SH "Constructor & Destructor Documentation"
89
 
.PP 
90
 
.SS "QwtPlotGrid::QwtPlotGrid ()\fC [explicit]\fP"
91
 
.PP
92
 
Enables major grid, disables minor grid. 
93
 
.PP
94
 
Definition at line 42 of file qwt_plot_grid.cpp.
95
 
.PP
96
 
References QwtPlotItem::setZ().
97
 
.SS "QwtPlotGrid::~QwtPlotGrid ()\fC [virtual]\fP"
98
 
.PP
99
 
Destructor. 
100
 
.PP
101
 
Definition at line 50 of file qwt_plot_grid.cpp.
102
 
.SH "Member Function Documentation"
103
 
.PP 
104
 
.SS "int QwtPlotGrid::rtti () const\fC [virtual]\fP"
105
 
.PP
106
 
\fBReturns:\fP
107
 
.RS 4
108
 
QwtPlotItem::Rtti_PlotGrid 
109
 
.RE
110
 
.PP
111
 
 
112
 
.PP
113
 
Reimplemented from \fBQwtPlotItem\fP.
114
 
.PP
115
 
Definition at line 56 of file qwt_plot_grid.cpp.
116
 
.SS "void QwtPlotGrid::enableX (bool tf)"
117
 
.PP
118
 
Enable or disable vertical gridlines. 
119
 
.PP
120
 
\fBParameters:\fP
121
 
.RS 4
122
 
\fItf\fP Enable (true) or disable
123
 
.RE
124
 
.PP
125
 
\fBSee also:\fP
126
 
.RS 4
127
 
Minor gridlines can be enabled or disabled with \fBenableXMin()\fP 
128
 
.RE
129
 
.PP
130
 
 
131
 
.PP
132
 
Definition at line 68 of file qwt_plot_grid.cpp.
133
 
.PP
134
 
References QwtPlotItem::itemChanged().
135
 
.SS "bool QwtPlotGrid::xEnabled () const"
136
 
.PP
137
 
\fBReturns:\fP
138
 
.RS 4
139
 
true if vertical gridlines are enabled 
140
 
.RE
141
 
.PP
142
 
\fBSee also:\fP
143
 
.RS 4
144
 
\fBenableX()\fP 
145
 
.RE
146
 
.PP
147
 
 
148
 
.PP
149
 
Definition at line 289 of file qwt_plot_grid.cpp.
150
 
.SS "void QwtPlotGrid::enableY (bool tf)"
151
 
.PP
152
 
Enable or disable horizontal gridlines. 
153
 
.PP
154
 
\fBParameters:\fP
155
 
.RS 4
156
 
\fItf\fP Enable (true) or disable 
157
 
.RE
158
 
.PP
159
 
\fBSee also:\fP
160
 
.RS 4
161
 
Minor gridlines can be enabled or disabled with \fBenableYMin()\fP 
162
 
.RE
163
 
.PP
164
 
 
165
 
.PP
166
 
Definition at line 82 of file qwt_plot_grid.cpp.
167
 
.PP
168
 
References QwtPlotItem::itemChanged().
169
 
.SS "bool QwtPlotGrid::yEnabled () const"
170
 
.PP
171
 
\fBReturns:\fP
172
 
.RS 4
173
 
true if horizontal gridlines are enabled 
174
 
.RE
175
 
.PP
176
 
\fBSee also:\fP
177
 
.RS 4
178
 
\fBenableY()\fP 
179
 
.RE
180
 
.PP
181
 
 
182
 
.PP
183
 
Definition at line 307 of file qwt_plot_grid.cpp.
184
 
.SS "void QwtPlotGrid::enableXMin (bool tf)"
185
 
.PP
186
 
Enable or disable minor vertical gridlines. 
187
 
.PP
188
 
\fBParameters:\fP
189
 
.RS 4
190
 
\fItf\fP Enable (true) or disable 
191
 
.RE
192
 
.PP
193
 
\fBSee also:\fP
194
 
.RS 4
195
 
\fBenableX()\fP 
196
 
.RE
197
 
.PP
198
 
 
199
 
.PP
200
 
Definition at line 96 of file qwt_plot_grid.cpp.
201
 
.PP
202
 
References QwtPlotItem::itemChanged().
203
 
.SS "bool QwtPlotGrid::xMinEnabled () const"
204
 
.PP
205
 
\fBReturns:\fP
206
 
.RS 4
207
 
true if minor vertical gridlines are enabled 
208
 
.RE
209
 
.PP
210
 
\fBSee also:\fP
211
 
.RS 4
212
 
\fBenableXMin()\fP 
213
 
.RE
214
 
.PP
215
 
 
216
 
.PP
217
 
Definition at line 298 of file qwt_plot_grid.cpp.
218
 
.SS "void QwtPlotGrid::enableYMin (bool tf)"
219
 
.PP
220
 
Enable or disable minor horizontal gridlines. 
221
 
.PP
222
 
\fBParameters:\fP
223
 
.RS 4
224
 
\fItf\fP Enable (true) or disable 
225
 
.RE
226
 
.PP
227
 
\fBSee also:\fP
228
 
.RS 4
229
 
\fBenableY()\fP 
230
 
.RE
231
 
.PP
232
 
 
233
 
.PP
234
 
Definition at line 110 of file qwt_plot_grid.cpp.
235
 
.PP
236
 
References QwtPlotItem::itemChanged().
237
 
.SS "bool QwtPlotGrid::yMinEnabled () const"
238
 
.PP
239
 
\fBReturns:\fP
240
 
.RS 4
241
 
true if minor horizontal gridlines are enabled 
242
 
.RE
243
 
.PP
244
 
\fBSee also:\fP
245
 
.RS 4
246
 
\fBenableYMin()\fP 
247
 
.RE
248
 
.PP
249
 
 
250
 
.PP
251
 
Definition at line 316 of file qwt_plot_grid.cpp.
252
 
.SS "void QwtPlotGrid::setXDiv (const \fBQwtScaleDiv\fP & scaleDiv)"
253
 
.PP
254
 
Assign an x axis scale division. 
255
 
.PP
256
 
\fBParameters:\fP
257
 
.RS 4
258
 
\fIscaleDiv\fP Scale division 
259
 
.RE
260
 
.PP
261
 
\fBWarning:\fP
262
 
.RS 4
263
 
\fBQwtPlotGrid\fP uses implicit sharing (see Qt Manual) for the scale divisions. 
264
 
.RE
265
 
.PP
266
 
 
267
 
.PP
268
 
Definition at line 125 of file qwt_plot_grid.cpp.
269
 
.PP
270
 
References QwtPlotItem::itemChanged().
271
 
.PP
272
 
Referenced by updateScaleDiv().
273
 
.SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::xScaleDiv () const"
274
 
.PP
275
 
\fBReturns:\fP
276
 
.RS 4
277
 
the scale division of the x axis 
278
 
.RE
279
 
.PP
280
 
 
281
 
.PP
282
 
Definition at line 323 of file qwt_plot_grid.cpp.
283
 
.SS "void QwtPlotGrid::setYDiv (const \fBQwtScaleDiv\fP & sy)"
284
 
.PP
285
 
Assign a y axis division. 
286
 
.PP
287
 
\fBParameters:\fP
288
 
.RS 4
289
 
\fIsy\fP Scale division 
290
 
.RE
291
 
.PP
292
 
\fBWarning:\fP
293
 
.RS 4
294
 
\fBQwtPlotGrid\fP uses implicit sharing (see Qt Manual) for the scale divisions. 
295
 
.RE
296
 
.PP
297
 
 
298
 
.PP
299
 
Definition at line 140 of file qwt_plot_grid.cpp.
300
 
.PP
301
 
References QwtPlotItem::itemChanged().
302
 
.PP
303
 
Referenced by updateScaleDiv().
304
 
.SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::yScaleDiv () const"
305
 
.PP
306
 
\fBReturns:\fP
307
 
.RS 4
308
 
the scale division of the y axis 
309
 
.RE
310
 
.PP
311
 
 
312
 
.PP
313
 
Definition at line 329 of file qwt_plot_grid.cpp.
314
 
.SS "void QwtPlotGrid::setPen (const QPen & p)"
315
 
.PP
316
 
Assign a pen for both major and minor gridlines. 
317
 
.PP
318
 
\fBParameters:\fP
319
 
.RS 4
320
 
\fIp\fP Pen 
321
 
.RE
322
 
.PP
323
 
\fBSee also:\fP
324
 
.RS 4
325
 
\fBsetMajPen()\fP, \fBsetMinPen()\fP 
326
 
.RE
327
 
.PP
328
 
 
329
 
.PP
330
 
Definition at line 154 of file qwt_plot_grid.cpp.
331
 
.PP
332
 
References QwtPlotItem::itemChanged().
333
 
.SS "void QwtPlotGrid::setMajPen (const QPen & p)"
334
 
.PP
335
 
Assign a pen for the major gridlines. 
336
 
.PP
337
 
\fBParameters:\fP
338
 
.RS 4
339
 
\fIp\fP Pen 
340
 
.RE
341
 
.PP
342
 
\fBSee also:\fP
343
 
.RS 4
344
 
\fBmajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP 
345
 
.RE
346
 
.PP
347
 
 
348
 
.PP
349
 
Definition at line 169 of file qwt_plot_grid.cpp.
350
 
.PP
351
 
References QwtPlotItem::itemChanged().
352
 
.SS "const QPen & QwtPlotGrid::majPen () const"
353
 
.PP
354
 
\fBReturns:\fP
355
 
.RS 4
356
 
the pen for the major gridlines 
357
 
.RE
358
 
.PP
359
 
\fBSee also:\fP
360
 
.RS 4
361
 
\fBsetMajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP 
362
 
.RE
363
 
.PP
364
 
 
365
 
.PP
366
 
Definition at line 271 of file qwt_plot_grid.cpp.
367
 
.SS "void QwtPlotGrid::setMinPen (const QPen & p)"
368
 
.PP
369
 
Assign a pen for the minor gridlines. 
370
 
.PP
371
 
\fBParameters:\fP
372
 
.RS 4
373
 
\fIp\fP Pen 
374
 
.RE
375
 
.PP
376
 
 
377
 
.PP
378
 
Definition at line 182 of file qwt_plot_grid.cpp.
379
 
.PP
380
 
References QwtPlotItem::itemChanged().
381
 
.SS "const QPen & QwtPlotGrid::minPen () const"
382
 
.PP
383
 
\fBReturns:\fP
384
 
.RS 4
385
 
the pen for the minor gridlines 
386
 
.RE
387
 
.PP
388
 
\fBSee also:\fP
389
 
.RS 4
390
 
\fBsetMinPen()\fP, \fBsetMajPen()\fP, \fBsetPen()\fP 
391
 
.RE
392
 
.PP
393
 
 
394
 
.PP
395
 
Definition at line 280 of file qwt_plot_grid.cpp.
396
 
.SS "void QwtPlotGrid::draw (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRect & canvasRect) const\fC [virtual]\fP"
397
 
.PP
398
 
Draw the grid. 
399
 
.PP
400
 
The grid is drawn into the bounding rectangle such that gridlines begin and end at the rectangle's borders. The X and Y maps are used to map the scale divisions into the drawing region screen. 
401
 
.PP
402
 
\fBParameters:\fP
403
 
.RS 4
404
 
\fIpainter\fP Painter 
405
 
.br
406
 
\fIxMap\fP X axis map 
407
 
.br
408
 
\fIyMap\fP Y axis 
409
 
.br
410
 
\fIcanvasRect\fP Contents rect of the plot canvas 
411
 
.RE
412
 
.PP
413
 
 
414
 
.PP
415
 
Implements \fBQwtPlotItem\fP.
416
 
.PP
417
 
Definition at line 203 of file qwt_plot_grid.cpp.
418
 
.SS "void QwtPlotGrid::updateScaleDiv (const \fBQwtScaleDiv\fP & xMap, const \fBQwtScaleDiv\fP & yMap)\fC [virtual]\fP"
419
 
.PP
420
 
Update the item to changes of the axes scale division. 
421
 
.PP
422
 
Update the item, when the axes of plot have changed. The default implementation does nothing, but items that depend on the scale division (like \fBQwtPlotGrid()\fP) have to reimplement \fBupdateScaleDiv()\fP
423
 
.PP
424
 
\fBParameters:\fP
425
 
.RS 4
426
 
\fIxScaleDiv\fP Scale division of the x-axis 
427
 
.br
428
 
\fIyScaleDiv\fP Scale division of the y-axis
429
 
.RE
430
 
.PP
431
 
\fBSee also:\fP
432
 
.RS 4
433
 
\fBQwtPlot::updateAxes()\fP 
434
 
.RE
435
 
.PP
436
 
 
437
 
.PP
438
 
Reimplemented from \fBQwtPlotItem\fP.
439
 
.PP
440
 
Definition at line 334 of file qwt_plot_grid.cpp.
441
 
.PP
442
 
References setXDiv(), and setYDiv().
443
 
 
444
 
.SH "Author"
445
 
.PP 
446
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.