← Back to branch summary

~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.1/doc/man/man3/QwtPlotMarker.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
http://bugs.debian.org/437877
http://bugs.debian.org/443110
* 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:
qwt-5.0.1/doc/man/man3/QwtPlotMarker.3
1
 
.TH "QwtPlotMarker" 3 "26 Feb 2007" "Version 5.0.1" "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 "QwtDoublePoint \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 QwtDoublePoint &)"
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 QwtDoubleRect \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 48 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 56 of file qwt_plot_marker.cpp.
127
 
.SH "Member Function Documentation"
128
 
.PP 
129
 
.SS "QwtDoubleRect QwtPlotMarker::boundingRect () const\fC [virtual]\fP"
130
 
.PP
131
 
\fBReturns:\fP
132
 
.RS 4
133
 
An invalid bounding rect: QwtDoubleRect(1.0, 1.0, -2.0, -2.0) 
134
 
.RE
135
 
.PP
136
 
 
137
 
.PP
138
 
Reimplemented from \fBQwtPlotItem\fP.
139
 
.PP
140
 
Definition at line 350 of file qwt_plot_marker.cpp.
141
 
.SS "void QwtPlotMarker::draw (QPainter * p, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRect & r) const\fC [virtual]\fP"
142
 
.PP
143
 
Draw the marker. 
144
 
.PP
145
 
\fBParameters:\fP
146
 
.RS 4
147
 
\fIp\fP Painter 
148
 
.br
149
 
\fIxMap\fP x Scale Map 
150
 
.br
151
 
\fIyMap\fP y Scale Map 
152
 
.br
153
 
\fIr\fP Bounding rect, where to paint 
154
 
.RE
155
 
.PP
156
 
 
157
 
.PP
158
 
Implements \fBQwtPlotItem\fP.
159
 
.PP
160
 
Definition at line 120 of file qwt_plot_marker.cpp.
161
 
.PP
162
 
References QwtPainter::drawLine(), and QwtScaleMap::transform().
163
 
.SS "\fBQwtText\fP QwtPlotMarker::label () const"
164
 
.PP
165
 
\fBReturns:\fP
166
 
.RS 4
167
 
the label 
168
 
.RE
169
 
.PP
170
 
\fBSee also:\fP
171
 
.RS 4
172
 
\fBsetLabel()\fP 
173
 
.RE
174
 
.PP
175
 
 
176
 
.PP
177
 
Definition at line 285 of file qwt_plot_marker.cpp.
178
 
.PP
179
 
Referenced by setLabel().
180
 
.SS "Qt::Alignment QwtPlotMarker::labelAlignment () const"
181
 
.PP
182
 
\fBReturns:\fP
183
 
.RS 4
184
 
the label alignment 
185
 
.RE
186
 
.PP
187
 
\fBSee also:\fP
188
 
.RS 4
189
 
\fBsetLabelAlignment()\fP 
190
 
.RE
191
 
.PP
192
 
 
193
 
.PP
194
 
Definition at line 321 of file qwt_plot_marker.cpp.
195
 
.SS "const QPen & QwtPlotMarker::linePen () const"
196
 
.PP
197
 
\fBReturns:\fP
198
 
.RS 4
199
 
the line pen 
200
 
.RE
201
 
.PP
202
 
\fBSee also:\fP
203
 
.RS 4
204
 
\fBsetLinePen()\fP 
205
 
.RE
206
 
.PP
207
 
 
208
 
.PP
209
 
Definition at line 345 of file qwt_plot_marker.cpp.
210
 
.SS "\fBQwtPlotMarker::LineStyle\fP QwtPlotMarker::lineStyle () const"
211
 
.PP
212
 
\fBReturns:\fP
213
 
.RS 4
214
 
the line style 
215
 
.RE
216
 
.PP
217
 
\fBSee also:\fP
218
 
.RS 4
219
 
For a description of line styles, see \fBQwtPlotMarker::setLineStyle()\fP 
220
 
.RE
221
 
.PP
222
 
 
223
 
.PP
224
 
Definition at line 242 of file qwt_plot_marker.cpp.
225
 
.SS "void QwtPlotMarker::setLabel (const \fBQwtText\fP & label)"
226
 
.PP
227
 
Set the label. 
228
 
.PP
229
 
\fBParameters:\fP
230
 
.RS 4
231
 
\fIlabel\fP label text 
232
 
.RE
233
 
.PP
234
 
\fBSee also:\fP
235
 
.RS 4
236
 
\fBlabel()\fP 
237
 
.RE
238
 
.PP
239
 
 
240
 
.PP
241
 
Definition at line 272 of file qwt_plot_marker.cpp.
242
 
.PP
243
 
References QwtPlotItem::itemChanged(), and label().
244
 
.SS "void QwtPlotMarker::setLabelAlignment (Qt::Alignment align)"
245
 
.PP
246
 
Set the alignment of the label. 
247
 
.PP
248
 
The alignment determines where the label is drawn relative to the marker's position.
249
 
.PP
250
 
\fBParameters:\fP
251
 
.RS 4
252
 
\fIalign\fP Alignment. A combination of AlignTop, AlignBottom, AlignLeft, AlignRight, AlignCenter, AlgnHCenter, AlignVCenter. 
253
 
.RE
254
 
.PP
255
 
\fBSee also:\fP
256
 
.RS 4
257
 
\fBlabelAlignment()\fP 
258
 
.RE
259
 
.PP
260
 
 
261
 
.PP
262
 
Definition at line 304 of file qwt_plot_marker.cpp.
263
 
.SS "void QwtPlotMarker::setLinePen (const QPen & p)"
264
 
.PP
265
 
Specify a pen for the line. 
266
 
.PP
267
 
\fBParameters:\fP
268
 
.RS 4
269
 
\fIp\fP New pen 
270
 
.RE
271
 
.PP
272
 
\fBSee also:\fP
273
 
.RS 4
274
 
\fBlinePen()\fP 
275
 
.RE
276
 
.PP
277
 
 
278
 
.PP
279
 
Definition at line 332 of file qwt_plot_marker.cpp.
280
 
.PP
281
 
References QwtPlotItem::itemChanged().
282
 
.SS "void QwtPlotMarker::setLineStyle (\fBQwtPlotMarker::LineStyle\fP st)"
283
 
.PP
284
 
Set the line style. 
285
 
.PP
286
 
\fBParameters:\fP
287
 
.RS 4
288
 
\fIst\fP Line style. Can be one of QwtPlotMarker::NoLine, HLine, VLine or Cross 
289
 
.RE
290
 
.PP
291
 
\fBSee also:\fP
292
 
.RS 4
293
 
\fBlineStyle()\fP 
294
 
.RE
295
 
.PP
296
 
 
297
 
.PP
298
 
Definition at line 229 of file qwt_plot_marker.cpp.
299
 
.PP
300
 
References QwtPlotItem::itemChanged().
301
 
.SS "void QwtPlotMarker::setSymbol (const \fBQwtSymbol\fP & s)"
302
 
.PP
303
 
Assign a symbol. 
304
 
.PP
305
 
\fBParameters:\fP
306
 
.RS 4
307
 
\fIs\fP New symbol 
308
 
.RE
309
 
.PP
310
 
\fBSee also:\fP
311
 
.RS 4
312
 
\fBsymbol()\fP 
313
 
.RE
314
 
.PP
315
 
 
316
 
.PP
317
 
Definition at line 252 of file qwt_plot_marker.cpp.
318
 
.PP
319
 
References QwtPlotItem::itemChanged().
320
 
.SS "void QwtPlotMarker::setValue (const QwtDoublePoint &)"
321
 
.PP
322
 
Set Value. 
323
 
.PP
324
 
Definition at line 85 of file qwt_plot_marker.cpp.
325
 
.PP
326
 
References setValue().
327
 
.SS "void QwtPlotMarker::setValue (double, double)"
328
 
.PP
329
 
Set Value. 
330
 
.PP
331
 
Definition at line 91 of file qwt_plot_marker.cpp.
332
 
.PP
333
 
References QwtPlotItem::itemChanged().
334
 
.PP
335
 
Referenced by setValue(), setXValue(), and setYValue().
336
 
.SS "void QwtPlotMarker::setXValue (double)"
337
 
.PP
338
 
Set X Value. 
339
 
.PP
340
 
Definition at line 102 of file qwt_plot_marker.cpp.
341
 
.PP
342
 
References setValue().
343
 
.SS "void QwtPlotMarker::setYValue (double)"
344
 
.PP
345
 
Set Y Value. 
346
 
.PP
347
 
Definition at line 108 of file qwt_plot_marker.cpp.
348
 
.PP
349
 
References setValue().
350
 
.SS "const \fBQwtSymbol\fP & QwtPlotMarker::symbol () const"
351
 
.PP
352
 
\fBReturns:\fP
353
 
.RS 4
354
 
the symbol 
355
 
.RE
356
 
.PP
357
 
\fBSee also:\fP
358
 
.RS 4
359
 
\fBsetSymbol()\fP, \fBQwtSymbol\fP 
360
 
.RE
361
 
.PP
362
 
 
363
 
.PP
364
 
Definition at line 262 of file qwt_plot_marker.cpp.
365
 
.SS "QwtDoublePoint QwtPlotMarker::value () const"
366
 
.PP
367
 
Return Value. 
368
 
.PP
369
 
Definition at line 67 of file qwt_plot_marker.cpp.
370
 
.SS "double QwtPlotMarker::xValue () const"
371
 
.PP
372
 
Return x Value. 
373
 
.PP
374
 
Definition at line 73 of file qwt_plot_marker.cpp.
375
 
.SS "double QwtPlotMarker::yValue () const"
376
 
.PP
377
 
Return y Value. 
378
 
.PP
379
 
Definition at line 79 of file qwt_plot_marker.cpp.
380
 
 
381
 
.SH "Author"
382
 
.PP 
383
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.