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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtPlotGrid.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "QwtPlotGrid" 3 "11 Jun 2007" "Version 5.0.2" "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 \fBQwtPlotGrid::setXDiv\fP and \fBQwtPlotGrid::setYDiv()\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 &, const \fBQwtScaleDiv\fP &)"
 
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
dtor 
 
100
.PP
 
101
Definition at line 50 of file qwt_plot_grid.cpp.
 
102
.SH "Member Function Documentation"
 
103
.PP 
 
104
.SS "void QwtPlotGrid::draw (QPainter * painter, const \fBQwtScaleMap\fP & mx, const \fBQwtScaleMap\fP & my, const QRect & r) const\fC [virtual]\fP"
 
105
.PP
 
106
Draw the grid. 
 
107
.PP
 
108
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. 
 
109
.PP
 
110
\fBParameters:\fP
 
111
.RS 4
 
112
\fIpainter\fP Painter 
 
113
.br
 
114
\fImx\fP X axis map 
 
115
.br
 
116
\fImy\fP Y axis 
 
117
.br
 
118
\fIr\fP Contents rect of the plot canvas 
 
119
.RE
 
120
.PP
 
121
 
 
122
.PP
 
123
Implements \fBQwtPlotItem\fP.
 
124
.PP
 
125
Definition at line 202 of file qwt_plot_grid.cpp.
 
126
.SS "void QwtPlotGrid::enableX (bool tf)"
 
127
.PP
 
128
Enable or disable vertical gridlines. 
 
129
.PP
 
130
\fBParameters:\fP
 
131
.RS 4
 
132
\fItf\fP Enable (true) or disable
 
133
.RE
 
134
.PP
 
135
\fBSee also:\fP
 
136
.RS 4
 
137
Minor gridlines can be enabled or disabled with \fBenableXMin()\fP 
 
138
.RE
 
139
.PP
 
140
 
 
141
.PP
 
142
Definition at line 67 of file qwt_plot_grid.cpp.
 
143
.PP
 
144
References QwtPlotItem::itemChanged().
 
145
.SS "void QwtPlotGrid::enableXMin (bool tf)"
 
146
.PP
 
147
Enable or disable minor vertical gridlines. 
 
148
.PP
 
149
\fBParameters:\fP
 
150
.RS 4
 
151
\fItf\fP Enable (true) or disable 
 
152
.RE
 
153
.PP
 
154
\fBSee also:\fP
 
155
.RS 4
 
156
\fBenableX()\fP 
 
157
.RE
 
158
.PP
 
159
 
 
160
.PP
 
161
Definition at line 95 of file qwt_plot_grid.cpp.
 
162
.PP
 
163
References QwtPlotItem::itemChanged().
 
164
.SS "void QwtPlotGrid::enableY (bool tf)"
 
165
.PP
 
166
Enable or disable horizontal gridlines. 
 
167
.PP
 
168
\fBParameters:\fP
 
169
.RS 4
 
170
\fItf\fP Enable (true) or disable 
 
171
.RE
 
172
.PP
 
173
\fBSee also:\fP
 
174
.RS 4
 
175
Minor gridlines can be enabled or disabled with \fBenableYMin()\fP 
 
176
.RE
 
177
.PP
 
178
 
 
179
.PP
 
180
Definition at line 81 of file qwt_plot_grid.cpp.
 
181
.PP
 
182
References QwtPlotItem::itemChanged().
 
183
.SS "void QwtPlotGrid::enableYMin (bool tf)"
 
184
.PP
 
185
Enable or disable minor horizontal gridlines. 
 
186
.PP
 
187
\fBParameters:\fP
 
188
.RS 4
 
189
\fItf\fP Enable (true) or disable 
 
190
.RE
 
191
.PP
 
192
\fBSee also:\fP
 
193
.RS 4
 
194
\fBenableY()\fP 
 
195
.RE
 
196
.PP
 
197
 
 
198
.PP
 
199
Definition at line 109 of file qwt_plot_grid.cpp.
 
200
.PP
 
201
References QwtPlotItem::itemChanged().
 
202
.SS "const QPen & QwtPlotGrid::majPen () const"
 
203
.PP
 
204
\fBReturns:\fP
 
205
.RS 4
 
206
the pen for the major gridlines 
 
207
.RE
 
208
.PP
 
209
\fBSee also:\fP
 
210
.RS 4
 
211
\fBsetMajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP 
 
212
.RE
 
213
.PP
 
214
 
 
215
.PP
 
216
Definition at line 270 of file qwt_plot_grid.cpp.
 
217
.SS "const QPen & QwtPlotGrid::minPen () const"
 
218
.PP
 
219
\fBReturns:\fP
 
220
.RS 4
 
221
the pen for the minor gridlines 
 
222
.RE
 
223
.PP
 
224
\fBSee also:\fP
 
225
.RS 4
 
226
\fBsetMinPen()\fP, \fBsetMajPen()\fP, \fBsetPen()\fP 
 
227
.RE
 
228
.PP
 
229
 
 
230
.PP
 
231
Definition at line 279 of file qwt_plot_grid.cpp.
 
232
.SS "void QwtPlotGrid::setMajPen (const QPen & p)"
 
233
.PP
 
234
Assign a pen for the major gridlines. 
 
235
.PP
 
236
\fBParameters:\fP
 
237
.RS 4
 
238
\fIp\fP Pen 
 
239
.RE
 
240
.PP
 
241
\fBSee also:\fP
 
242
.RS 4
 
243
\fBmajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP 
 
244
.RE
 
245
.PP
 
246
 
 
247
.PP
 
248
Definition at line 168 of file qwt_plot_grid.cpp.
 
249
.PP
 
250
References QwtPlotItem::itemChanged().
 
251
.SS "void QwtPlotGrid::setMinPen (const QPen & p)"
 
252
.PP
 
253
Assign a pen for the minor gridlines. 
 
254
.PP
 
255
\fBParameters:\fP
 
256
.RS 4
 
257
\fIp\fP Pen 
 
258
.RE
 
259
.PP
 
260
 
 
261
.PP
 
262
Definition at line 181 of file qwt_plot_grid.cpp.
 
263
.PP
 
264
References QwtPlotItem::itemChanged().
 
265
.SS "void QwtPlotGrid::setPen (const QPen & p)"
 
266
.PP
 
267
Assign a pen for both major and minor gridlines. 
 
268
.PP
 
269
\fBParameters:\fP
 
270
.RS 4
 
271
\fIp\fP Pen 
 
272
.RE
 
273
.PP
 
274
\fBSee also:\fP
 
275
.RS 4
 
276
\fBsetMajPen()\fP, \fBsetMinPen()\fP 
 
277
.RE
 
278
.PP
 
279
 
 
280
.PP
 
281
Definition at line 153 of file qwt_plot_grid.cpp.
 
282
.PP
 
283
References QwtPlotItem::itemChanged().
 
284
.SS "void QwtPlotGrid::setXDiv (const \fBQwtScaleDiv\fP & sx)"
 
285
.PP
 
286
Assign an x axis scale division. 
 
287
.PP
 
288
\fBParameters:\fP
 
289
.RS 4
 
290
\fIsx\fP Scale division 
 
291
.RE
 
292
.PP
 
293
\fBWarning:\fP
 
294
.RS 4
 
295
\fBQwtPlotGrid\fP uses implicit sharing (see Qt Manual) for the scale divisions. 
 
296
.RE
 
297
.PP
 
298
 
 
299
.PP
 
300
Definition at line 124 of file qwt_plot_grid.cpp.
 
301
.PP
 
302
References QwtPlotItem::itemChanged().
 
303
.PP
 
304
Referenced by updateScaleDiv().
 
305
.SS "void QwtPlotGrid::setYDiv (const \fBQwtScaleDiv\fP & sy)"
 
306
.PP
 
307
Assign a y axis division. 
 
308
.PP
 
309
\fBParameters:\fP
 
310
.RS 4
 
311
\fIsy\fP Scale division 
 
312
.RE
 
313
.PP
 
314
\fBWarning:\fP
 
315
.RS 4
 
316
\fBQwtPlotGrid\fP uses implicit sharing (see Qt Manual) for the scale divisions. 
 
317
.RE
 
318
.PP
 
319
 
 
320
.PP
 
321
Definition at line 139 of file qwt_plot_grid.cpp.
 
322
.PP
 
323
References QwtPlotItem::itemChanged().
 
324
.PP
 
325
Referenced by updateScaleDiv().
 
326
.SS "void QwtPlotGrid::updateScaleDiv (const \fBQwtScaleDiv\fP & xDiv, const \fBQwtScaleDiv\fP & yDiv)\fC [virtual]\fP"
 
327
.PP
 
328
Update the item to changes of the axes scale division. 
 
329
.PP
 
330
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
 
331
.PP
 
332
\fBParameters:\fP
 
333
.RS 4
 
334
\fIxScaleDiv\fP Scale division of the x-axis 
 
335
.br
 
336
\fIyScaleDiv\fP Scale division of the y-axis
 
337
.RE
 
338
.PP
 
339
\fBSee also:\fP
 
340
.RS 4
 
341
\fBQwtPlot::updateAxes()\fP 
 
342
.RE
 
343
.PP
 
344
 
 
345
.PP
 
346
Reimplemented from \fBQwtPlotItem\fP.
 
347
.PP
 
348
Definition at line 333 of file qwt_plot_grid.cpp.
 
349
.PP
 
350
References setXDiv(), and setYDiv().
 
351
.SS "bool QwtPlotGrid::xEnabled () const"
 
352
.PP
 
353
\fBReturns:\fP
 
354
.RS 4
 
355
true if vertical gridlines are enabled 
 
356
.RE
 
357
.PP
 
358
\fBSee also:\fP
 
359
.RS 4
 
360
\fBenableX()\fP 
 
361
.RE
 
362
.PP
 
363
 
 
364
.PP
 
365
Definition at line 288 of file qwt_plot_grid.cpp.
 
366
.SS "bool QwtPlotGrid::xMinEnabled () const"
 
367
.PP
 
368
\fBReturns:\fP
 
369
.RS 4
 
370
true if minor vertical gridlines are enabled 
 
371
.RE
 
372
.PP
 
373
\fBSee also:\fP
 
374
.RS 4
 
375
\fBenableXMin()\fP 
 
376
.RE
 
377
.PP
 
378
 
 
379
.PP
 
380
Definition at line 297 of file qwt_plot_grid.cpp.
 
381
.SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::xScaleDiv () const"
 
382
.PP
 
383
\fBReturns:\fP
 
384
.RS 4
 
385
the scale division of the x axis 
 
386
.RE
 
387
.PP
 
388
 
 
389
.PP
 
390
Definition at line 322 of file qwt_plot_grid.cpp.
 
391
.SS "bool QwtPlotGrid::yEnabled () const"
 
392
.PP
 
393
\fBReturns:\fP
 
394
.RS 4
 
395
true if horizontal gridlines are enabled 
 
396
.RE
 
397
.PP
 
398
\fBSee also:\fP
 
399
.RS 4
 
400
\fBenableY()\fP 
 
401
.RE
 
402
.PP
 
403
 
 
404
.PP
 
405
Definition at line 306 of file qwt_plot_grid.cpp.
 
406
.SS "bool QwtPlotGrid::yMinEnabled () const"
 
407
.PP
 
408
\fBReturns:\fP
 
409
.RS 4
 
410
true if minor horizontal gridlines are enabled 
 
411
.RE
 
412
.PP
 
413
\fBSee also:\fP
 
414
.RS 4
 
415
\fBenableYMin()\fP 
 
416
.RE
 
417
.PP
 
418
 
 
419
.PP
 
420
Definition at line 315 of file qwt_plot_grid.cpp.
 
421
.SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::yScaleDiv () const"
 
422
.PP
 
423
\fBReturns:\fP
 
424
.RS 4
 
425
the scale division of the y axis 
 
426
.RE
 
427
.PP
 
428
 
 
429
.PP
 
430
Definition at line 328 of file qwt_plot_grid.cpp.
 
431
 
 
432
.SH "Author"
 
433
.PP 
 
434
Generated automatically by Doxygen for Qwt User's Guide from the source code.