← 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/QwtPlotMarker.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/QwtPlotMarker.3
1
 
.TH "QwtPlotMarker" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotMarker \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtPlotItem\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
A class for drawing markers. 
14
 
 
15
 
A marker can be a horizontal line, a vertical line, a symbol, a label or any combination of them, which can be drawn around a center point inside a bounding rectangle.
16
 
.PP
17
 
The \fBQwtPlotMarker::setSymbol()\fP member assigns a symbol to the marker. The symbol is drawn at the specified point.
18
 
.PP
19
 
With \fBQwtPlotMarker::setLabel()\fP, a label can be assigned to the marker. The \fBQwtPlotMarker::setLabelAlignment()\fP member specifies where the label is drawn. All the Align*-constants in Qt::AlignmentFlags (see Qt documentation) are valid. The interpretation of the alignment depends on the marker's line style. The alignment refers to the center point of the marker, which means, for example, that the label would be printed left above the center point if the alignment was set to AlignLeft|AlignTop. 
20
 
.PP
21
 
Definition at line 45 of file qwt_plot_marker.h.
22
 
.SS "Public Types"
23
 
 
24
 
.in +1c
25
 
.ti -1c
26
 
.RI "enum \fBLineStyle\fP { \fBNoLine\fP, \fBHLine\fP, \fBVLine\fP, \fBCross\fP }"
27
 
.br
28
 
.in -1c
29
 
.SS "Public Member Functions"
30
 
 
31
 
.in +1c
32
 
.ti -1c
33
 
.RI "\fBQwtPlotMarker\fP ()"
34
 
.br
35
 
.ti -1c
36
 
.RI "virtual \fB~QwtPlotMarker\fP ()"
37
 
.br
38
 
.ti -1c
39
 
.RI "virtual int \fBrtti\fP () const"
40
 
.br
41
 
.ti -1c
42
 
.RI "double \fBxValue\fP () const"
43
 
.br
44
 
.ti -1c
45
 
.RI "double \fByValue\fP () const"
46
 
.br
47
 
.ti -1c
48
 
.RI "\fBQwtDoublePoint\fP \fBvalue\fP () const"
49
 
.br
50
 
.ti -1c
51
 
.RI "void \fBsetXValue\fP (double)"
52
 
.br
53
 
.ti -1c
54
 
.RI "void \fBsetYValue\fP (double)"
55
 
.br
56
 
.ti -1c
57
 
.RI "void \fBsetValue\fP (double, double)"
58
 
.br
59
 
.ti -1c
60
 
.RI "void \fBsetValue\fP (const \fBQwtDoublePoint\fP &)"
61
 
.br
62
 
.ti -1c
63
 
.RI "void \fBsetLineStyle\fP (\fBLineStyle\fP st)"
64
 
.br
65
 
.ti -1c
66
 
.RI "\fBLineStyle\fP \fBlineStyle\fP () const"
67
 
.br
68
 
.ti -1c
69
 
.RI "void \fBsetLinePen\fP (const QPen &p)"
70
 
.br
71
 
.ti -1c
72
 
.RI "const QPen & \fBlinePen\fP () const"
73
 
.br
74
 
.ti -1c
75
 
.RI "void \fBsetSymbol\fP (const \fBQwtSymbol\fP &s)"
76
 
.br
77
 
.ti -1c
78
 
.RI "const \fBQwtSymbol\fP & \fBsymbol\fP () const"
79
 
.br
80
 
.ti -1c
81
 
.RI "void \fBsetLabel\fP (const \fBQwtText\fP &)"
82
 
.br
83
 
.ti -1c
84
 
.RI "\fBQwtText\fP \fBlabel\fP () const"
85
 
.br
86
 
.ti -1c
87
 
.RI "void \fBsetLabelAlignment\fP (Qt::Alignment)"
88
 
.br
89
 
.ti -1c
90
 
.RI "Qt::Alignment \fBlabelAlignment\fP () const"
91
 
.br
92
 
.ti -1c
93
 
.RI "virtual void \fBdraw\fP (QPainter *p, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &) const"
94
 
.br
95
 
.ti -1c
96
 
.RI "virtual \fBQwtDoubleRect\fP \fBboundingRect\fP () const"
97
 
.br
98
 
.in -1c
99
 
.SH "Member Enumeration Documentation"
100
 
.PP 
101
 
.SS "enum \fBQwtPlotMarker::LineStyle\fP"
102
 
.PP
103
 
Line styles. 
104
 
.PP
105
 
\fBSee also:\fP
106
 
.RS 4
107
 
\fBQwtPlotMarker::setLineStyle\fP, \fBQwtPlotMarker::lineStyle\fP 
108
 
.RE
109
 
.PP
110
 
 
111
 
.PP
112
 
Definition at line 53 of file qwt_plot_marker.h.
113
 
.SH "Constructor & Destructor Documentation"
114
 
.PP 
115
 
.SS "QwtPlotMarker::QwtPlotMarker ()\fC [explicit]\fP"
116
 
.PP
117
 
Sets alignment to Qt::AlignCenter, and style to NoLine. 
118
 
.PP
119
 
Definition at line 54 of file qwt_plot_marker.cpp.
120
 
.PP
121
 
References QwtPlotItem::setZ().
122
 
.SS "QwtPlotMarker::~QwtPlotMarker ()\fC [virtual]\fP"
123
 
.PP
124
 
Destructor. 
125
 
.PP
126
 
Definition at line 62 of file qwt_plot_marker.cpp.
127
 
.SH "Member Function Documentation"
128
 
.PP 
129
 
.SS "int QwtPlotMarker::rtti () const\fC [virtual]\fP"
130
 
.PP
131
 
\fBReturns:\fP
132
 
.RS 4
133
 
QwtPlotItem::Rtti_PlotMarker 
134
 
.RE
135
 
.PP
136
 
 
137
 
.PP
138
 
Reimplemented from \fBQwtPlotItem\fP.
139
 
.PP
140
 
Definition at line 68 of file qwt_plot_marker.cpp.
141
 
.SS "double QwtPlotMarker::xValue () const"
142
 
.PP
143
 
Return x Value. 
144
 
.PP
145
 
Definition at line 80 of file qwt_plot_marker.cpp.
146
 
.SS "double QwtPlotMarker::yValue () const"
147
 
.PP
148
 
Return y Value. 
149
 
.PP
150
 
Definition at line 86 of file qwt_plot_marker.cpp.
151
 
.SS "\fBQwtDoublePoint\fP QwtPlotMarker::value () const"
152
 
.PP
153
 
Return Value. 
154
 
.PP
155
 
Definition at line 74 of file qwt_plot_marker.cpp.
156
 
.SS "void QwtPlotMarker::setXValue (double)"
157
 
.PP
158
 
Set X Value. 
159
 
.PP
160
 
Definition at line 109 of file qwt_plot_marker.cpp.
161
 
.PP
162
 
References setValue().
163
 
.SS "void QwtPlotMarker::setYValue (double)"
164
 
.PP
165
 
Set Y Value. 
166
 
.PP
167
 
Definition at line 115 of file qwt_plot_marker.cpp.
168
 
.PP
169
 
References setValue().
170
 
.SS "void QwtPlotMarker::setValue (double, double)"
171
 
.PP
172
 
Set Value. 
173
 
.PP
174
 
Definition at line 98 of file qwt_plot_marker.cpp.
175
 
.PP
176
 
References QwtPlotItem::itemChanged().
177
 
.PP
178
 
Referenced by setValue(), setXValue(), and setYValue().
179
 
.SS "void QwtPlotMarker::setValue (const \fBQwtDoublePoint\fP &)"
180
 
.PP
181
 
Set Value. 
182
 
.PP
183
 
Definition at line 92 of file qwt_plot_marker.cpp.
184
 
.PP
185
 
References setValue().
186
 
.SS "void QwtPlotMarker::setLineStyle (\fBQwtPlotMarker::LineStyle\fP st)"
187
 
.PP
188
 
Set the line style. 
189
 
.PP
190
 
\fBParameters:\fP
191
 
.RS 4
192
 
\fIst\fP Line style. Can be one of QwtPlotMarker::NoLine, HLine, VLine or Cross 
193
 
.RE
194
 
.PP
195
 
\fBSee also:\fP
196
 
.RS 4
197
 
\fBlineStyle()\fP 
198
 
.RE
199
 
.PP
200
 
 
201
 
.PP
202
 
Definition at line 236 of file qwt_plot_marker.cpp.
203
 
.PP
204
 
References QwtPlotItem::itemChanged().
205
 
.SS "\fBQwtPlotMarker::LineStyle\fP QwtPlotMarker::lineStyle () const"
206
 
.PP
207
 
\fBReturns:\fP
208
 
.RS 4
209
 
the line style 
210
 
.RE
211
 
.PP
212
 
\fBSee also:\fP
213
 
.RS 4
214
 
For a description of line styles, see \fBQwtPlotMarker::setLineStyle()\fP 
215
 
.RE
216
 
.PP
217
 
 
218
 
.PP
219
 
Definition at line 249 of file qwt_plot_marker.cpp.
220
 
.SS "void QwtPlotMarker::setLinePen (const QPen & p)"
221
 
.PP
222
 
Specify a pen for the line. 
223
 
.PP
224
 
\fBParameters:\fP
225
 
.RS 4
226
 
\fIp\fP New pen 
227
 
.RE
228
 
.PP
229
 
\fBSee also:\fP
230
 
.RS 4
231
 
\fBlinePen()\fP 
232
 
.RE
233
 
.PP
234
 
 
235
 
.PP
236
 
Definition at line 340 of file qwt_plot_marker.cpp.
237
 
.PP
238
 
References QwtPlotItem::itemChanged().
239
 
.PP
240
 
Referenced by QwtPlotPrintFilter::apply().
241
 
.SS "const QPen & QwtPlotMarker::linePen () const"
242
 
.PP
243
 
\fBReturns:\fP
244
 
.RS 4
245
 
the line pen 
246
 
.RE
247
 
.PP
248
 
\fBSee also:\fP
249
 
.RS 4
250
 
\fBsetLinePen()\fP 
251
 
.RE
252
 
.PP
253
 
 
254
 
.PP
255
 
Definition at line 353 of file qwt_plot_marker.cpp.
256
 
.PP
257
 
Referenced by QwtPlotPrintFilter::apply().
258
 
.SS "void QwtPlotMarker::setSymbol (const \fBQwtSymbol\fP & s)"
259
 
.PP
260
 
Assign a symbol. 
261
 
.PP
262
 
\fBParameters:\fP
263
 
.RS 4
264
 
\fIs\fP New symbol 
265
 
.RE
266
 
.PP
267
 
\fBSee also:\fP
268
 
.RS 4
269
 
\fBsymbol()\fP 
270
 
.RE
271
 
.PP
272
 
 
273
 
.PP
274
 
Definition at line 259 of file qwt_plot_marker.cpp.
275
 
.PP
276
 
References QwtSymbol::clone(), and QwtPlotItem::itemChanged().
277
 
.PP
278
 
Referenced by QwtPlotPrintFilter::apply().
279
 
.SS "const \fBQwtSymbol\fP & QwtPlotMarker::symbol () const"
280
 
.PP
281
 
\fBReturns:\fP
282
 
.RS 4
283
 
the symbol 
284
 
.RE
285
 
.PP
286
 
\fBSee also:\fP
287
 
.RS 4
288
 
\fBsetSymbol()\fP, \fBQwtSymbol\fP 
289
 
.RE
290
 
.PP
291
 
 
292
 
.PP
293
 
Definition at line 270 of file qwt_plot_marker.cpp.
294
 
.PP
295
 
Referenced by QwtPlotPrintFilter::apply().
296
 
.SS "void QwtPlotMarker::setLabel (const \fBQwtText\fP & label)"
297
 
.PP
298
 
Set the label. 
299
 
.PP
300
 
\fBParameters:\fP
301
 
.RS 4
302
 
\fIlabel\fP label text 
303
 
.RE
304
 
.PP
305
 
\fBSee also:\fP
306
 
.RS 4
307
 
\fBlabel()\fP 
308
 
.RE
309
 
.PP
310
 
 
311
 
.PP
312
 
Definition at line 280 of file qwt_plot_marker.cpp.
313
 
.PP
314
 
References QwtPlotItem::itemChanged(), and label().
315
 
.PP
316
 
Referenced by QwtPlotPrintFilter::apply().
317
 
.SS "\fBQwtText\fP QwtPlotMarker::label () const"
318
 
.PP
319
 
\fBReturns:\fP
320
 
.RS 4
321
 
the label 
322
 
.RE
323
 
.PP
324
 
\fBSee also:\fP
325
 
.RS 4
326
 
\fBsetLabel()\fP 
327
 
.RE
328
 
.PP
329
 
 
330
 
.PP
331
 
Definition at line 293 of file qwt_plot_marker.cpp.
332
 
.PP
333
 
Referenced by QwtPlotPrintFilter::apply(), and setLabel().
334
 
.SS "void QwtPlotMarker::setLabelAlignment (Qt::Alignment align)"
335
 
.PP
336
 
Set the alignment of the label. 
337
 
.PP
338
 
The alignment determines where the label is drawn relative to the marker's position.
339
 
.PP
340
 
\fBParameters:\fP
341
 
.RS 4
342
 
\fIalign\fP Alignment. A combination of AlignTop, AlignBottom, AlignLeft, AlignRight, AlignCenter, AlgnHCenter, AlignVCenter. 
343
 
.RE
344
 
.PP
345
 
\fBSee also:\fP
346
 
.RS 4
347
 
\fBlabelAlignment()\fP 
348
 
.RE
349
 
.PP
350
 
 
351
 
.PP
352
 
Definition at line 312 of file qwt_plot_marker.cpp.
353
 
.SS "Qt::Alignment QwtPlotMarker::labelAlignment () const"
354
 
.PP
355
 
\fBReturns:\fP
356
 
.RS 4
357
 
the label alignment 
358
 
.RE
359
 
.PP
360
 
\fBSee also:\fP
361
 
.RS 4
362
 
\fBsetLabelAlignment()\fP 
363
 
.RE
364
 
.PP
365
 
 
366
 
.PP
367
 
Definition at line 329 of file qwt_plot_marker.cpp.
368
 
.SS "void QwtPlotMarker::draw (QPainter * p, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRect & r) const\fC [virtual]\fP"
369
 
.PP
370
 
Draw the marker. 
371
 
.PP
372
 
\fBParameters:\fP
373
 
.RS 4
374
 
\fIp\fP Painter 
375
 
.br
376
 
\fIxMap\fP x Scale Map 
377
 
.br
378
 
\fIyMap\fP y Scale Map 
379
 
.br
380
 
\fIr\fP Bounding rect, where to paint 
381
 
.RE
382
 
.PP
383
 
 
384
 
.PP
385
 
Implements \fBQwtPlotItem\fP.
386
 
.PP
387
 
Definition at line 127 of file qwt_plot_marker.cpp.
388
 
.PP
389
 
References QwtPainter::drawLine(), QwtPainter::metricsMap(), QwtMetricsMap::screenToLayoutX(), QwtMetricsMap::screenToLayoutY(), and QwtScaleMap::transform().
390
 
.SS "\fBQwtDoubleRect\fP QwtPlotMarker::boundingRect () const\fC [virtual]\fP"
391
 
.PP
392
 
\fBReturns:\fP
393
 
.RS 4
394
 
An invalid bounding rect: QwtDoubleRect(1.0, 1.0, -2.0, -2.0) 
395
 
.RE
396
 
.PP
397
 
 
398
 
.PP
399
 
Reimplemented from \fBQwtPlotItem\fP.
400
 
.PP
401
 
Definition at line 358 of file qwt_plot_marker.cpp.
402
 
 
403
 
.SH "Author"
404
 
.PP 
405
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.