← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtPlotCanvas.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtPlotCanvas.3
 
1
.TH "QwtPlotCanvas" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtPlotCanvas \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
Canvas of a \fBQwtPlot\fP. 
 
12
.PP
 
13
\fBSee also:\fP
 
14
.RS 4
 
15
\fBQwtPlot\fP 
 
16
.RE
 
17
.PP
 
18
 
 
19
.PP
 
20
Definition at line 26 of file qwt_plot_canvas.h.
 
21
.SS "Public Types"
 
22
 
 
23
.in +1c
 
24
.ti -1c
 
25
.RI "enum \fBPaintAttribute\fP { \fBPaintCached\fP =  1, \fBPaintPacked\fP =  2, \fBPaintFiltered\fP =  1, \fBClipPolygons\fP =  2, \fBPaintUsingTextFont\fP =  1, \fBPaintUsingTextColor\fP =  2, \fBPaintBackground\fP =  4 }"
 
26
.br
 
27
.ti -1c
 
28
.RI "enum \fBFocusIndicator\fP { \fBNoFocusIndicator\fP, \fBCanvasFocusIndicator\fP, \fBItemFocusIndicator\fP }"
 
29
.br
 
30
.in -1c
 
31
.SS "Public Member Functions"
 
32
 
 
33
.in +1c
 
34
.ti -1c
 
35
.RI "\fBQwtPlotCanvas\fP (\fBQwtPlot\fP *)"
 
36
.br
 
37
.ti -1c
 
38
.RI "virtual \fB~QwtPlotCanvas\fP ()"
 
39
.br
 
40
.ti -1c
 
41
.RI "\fBQwtPlot\fP * \fBplot\fP ()"
 
42
.br
 
43
.ti -1c
 
44
.RI "const \fBQwtPlot\fP * \fBplot\fP () const"
 
45
.br
 
46
.ti -1c
 
47
.RI "void \fBsetFocusIndicator\fP (\fBFocusIndicator\fP)"
 
48
.br
 
49
.ti -1c
 
50
.RI "\fBFocusIndicator\fP \fBfocusIndicator\fP () const"
 
51
.br
 
52
.ti -1c
 
53
.RI "void \fBsetPaintAttribute\fP (\fBPaintAttribute\fP, bool on=true)"
 
54
.br
 
55
.ti -1c
 
56
.RI "bool \fBtestPaintAttribute\fP (\fBPaintAttribute\fP) const"
 
57
.br
 
58
.ti -1c
 
59
.RI "QPixmap * \fBpaintCache\fP ()"
 
60
.br
 
61
.ti -1c
 
62
.RI "const QPixmap * \fBpaintCache\fP () const"
 
63
.br
 
64
.ti -1c
 
65
.RI "void \fBinvalidatePaintCache\fP ()"
 
66
.br
 
67
.in -1c
 
68
.SS "Protected Member Functions"
 
69
 
 
70
.in +1c
 
71
.ti -1c
 
72
.RI "virtual void \fBhideEvent\fP (QHideEvent *)"
 
73
.br
 
74
.ti -1c
 
75
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *)"
 
76
.br
 
77
.ti -1c
 
78
.RI "virtual void \fBdrawContents\fP (QPainter *)"
 
79
.br
 
80
.ti -1c
 
81
.RI "virtual void \fBdrawFocusIndicator\fP (QPainter *)"
 
82
.br
 
83
.ti -1c
 
84
.RI "void \fBdrawCanvas\fP (QPainter *painter=NULL)"
 
85
.br
 
86
.in -1c
 
87
.SH "Member Enumeration Documentation"
 
88
.PP 
 
89
.SS "enum \fBQwtPlotCanvas::PaintAttribute\fP"
 
90
.PP
 
91
Paint attributes. 
 
92
.PP
 
93
.IP "\(bu" 2
 
94
PaintCached
 
95
.br
 
96
 Paint double buffered and reuse the content of the pixmap buffer for some spontaneous repaints that happen when a plot gets unhidden, deiconified or changes the focus. Disabling the cache will improve the performance for incremental paints (using \fBQwtPlotCurve::draw\fP).
 
97
.PP
 
98
.PP
 
99
.IP "\(bu" 2
 
100
PaintPacked
 
101
.br
 
102
 Suppress system background repaints and paint it together with the canvas contents. Painting packed might avoid flickering for expensive repaints, when there is a notable gap between painting the background and the plot contents.
 
103
.PP
 
104
.PP
 
105
The default setting enables PaintCached and PaintPacked
 
106
.PP
 
107
\fBSee also:\fP
 
108
.RS 4
 
109
\fBsetPaintAttribute()\fP, \fBtestPaintAttribute()\fP, \fBpaintCache()\fP 
 
110
.RE
 
111
.PP
 
112
 
 
113
.PP
 
114
Definition at line 53 of file qwt_plot_canvas.h.
 
115
.SS "enum \fBQwtPlotCanvas::FocusIndicator\fP"
 
116
.PP
 
117
Focus indicator. 
 
118
.PP
 
119
.IP "\(bu" 2
 
120
NoFocusIndicator
 
121
.br
 
122
 Don't paint a focus indicator
 
123
.PP
 
124
.PP
 
125
.IP "\(bu" 2
 
126
CanvasFocusIndicator
 
127
.br
 
128
 The focus is related to the complete canvas. Paint the focus indicator using paintFocus()
 
129
.PP
 
130
.PP
 
131
.IP "\(bu" 2
 
132
ItemFocusIndicator
 
133
.br
 
134
 The focus is related to an item (curve, point, ...) on the canvas. It is up to the application to display a focus indication using f.e. highlighting.
 
135
.PP
 
136
.PP
 
137
\fBSee also:\fP
 
138
.RS 4
 
139
\fBsetFocusIndicator()\fP, \fBfocusIndicator()\fP, paintFocus() 
 
140
.RE
 
141
.PP
 
142
 
 
143
.PP
 
144
Definition at line 77 of file qwt_plot_canvas.h.
 
145
.SH "Constructor & Destructor Documentation"
 
146
.PP 
 
147
.SS "QwtPlotCanvas::QwtPlotCanvas (\fBQwtPlot\fP *)\fC [explicit]\fP"
 
148
.PP
 
149
Sets a cross cursor, enables QwtPlotCanvas::PaintCached. 
 
150
.PP
 
151
Definition at line 50 of file qwt_plot_canvas.cpp.
 
152
.PP
 
153
References setPaintAttribute().
 
154
.SS "QwtPlotCanvas::~QwtPlotCanvas ()\fC [virtual]\fP"
 
155
.PP
 
156
Destructor. 
 
157
.PP
 
158
Definition at line 75 of file qwt_plot_canvas.cpp.
 
159
.SH "Member Function Documentation"
 
160
.PP 
 
161
.SS "\fBQwtPlot\fP * QwtPlotCanvas::plot ()"
 
162
.PP
 
163
Return parent plot widget. 
 
164
.PP
 
165
Definition at line 81 of file qwt_plot_canvas.cpp.
 
166
.PP
 
167
Referenced by drawContents().
 
168
.SS "const \fBQwtPlot\fP * QwtPlotCanvas::plot () const"
 
169
.PP
 
170
Return parent plot widget. 
 
171
.PP
 
172
Definition at line 91 of file qwt_plot_canvas.cpp.
 
173
.SS "void QwtPlotCanvas::setFocusIndicator (\fBFocusIndicator\fP focusIndicator)"
 
174
.PP
 
175
Set the focus indicator
 
176
.PP
 
177
\fBSee also:\fP
 
178
.RS 4
 
179
\fBFocusIndicator\fP, \fBfocusIndicator\fP 
 
180
.RE
 
181
.PP
 
182
 
 
183
.PP
 
184
Definition at line 196 of file qwt_plot_canvas.cpp.
 
185
.SS "\fBQwtPlotCanvas::FocusIndicator\fP QwtPlotCanvas::focusIndicator () const"
 
186
.PP
 
187
\fBReturns:\fP
 
188
.RS 4
 
189
Focus indicator
 
190
.RE
 
191
.PP
 
192
\fBSee also:\fP
 
193
.RS 4
 
194
\fBFocusIndicator\fP, \fBsetFocusIndicator\fP 
 
195
.RE
 
196
.PP
 
197
 
 
198
.PP
 
199
Definition at line 206 of file qwt_plot_canvas.cpp.
 
200
.PP
 
201
Referenced by drawContents().
 
202
.SS "void QwtPlotCanvas::setPaintAttribute (\fBPaintAttribute\fP attribute, bool on = \fCtrue\fP)"
 
203
.PP
 
204
Changing the paint attributes. 
 
205
.PP
 
206
\fBParameters:\fP
 
207
.RS 4
 
208
\fIattribute\fP Paint attribute 
 
209
.br
 
210
\fIon\fP On/Off
 
211
.RE
 
212
.PP
 
213
The default setting enables PaintCached and PaintPacked
 
214
.PP
 
215
\fBSee also:\fP
 
216
.RS 4
 
217
\fBtestPaintAttribute()\fP, \fBdrawCanvas()\fP, \fBdrawContents()\fP, \fBpaintCache()\fP 
 
218
.RE
 
219
.PP
 
220
 
 
221
.PP
 
222
Definition at line 110 of file qwt_plot_canvas.cpp.
 
223
.PP
 
224
Referenced by QwtPlotCanvas().
 
225
.SS "bool QwtPlotCanvas::testPaintAttribute (\fBPaintAttribute\fP attribute) const"
 
226
.PP
 
227
Test wether a paint attribute is enabled
 
228
.PP
 
229
\fBParameters:\fP
 
230
.RS 4
 
231
\fIattribute\fP Paint attribute 
 
232
.RE
 
233
.PP
 
234
\fBReturns:\fP
 
235
.RS 4
 
236
true if the attribute is enabled 
 
237
.RE
 
238
.PP
 
239
\fBSee also:\fP
 
240
.RS 4
 
241
\fBsetPaintAttribute()\fP 
 
242
.RE
 
243
.PP
 
244
 
 
245
.PP
 
246
Definition at line 167 of file qwt_plot_canvas.cpp.
 
247
.PP
 
248
Referenced by QwtPlotCurve::draw(), and QwtPlot::replot().
 
249
.SS "QPixmap * QwtPlotCanvas::paintCache ()"
 
250
.PP
 
251
Return the paint cache, might be null. 
 
252
.PP
 
253
Definition at line 173 of file qwt_plot_canvas.cpp.
 
254
.PP
 
255
Referenced by QwtPlotCurve::draw().
 
256
.SS "const QPixmap * QwtPlotCanvas::paintCache () const"
 
257
.PP
 
258
Return the paint cache, might be null. 
 
259
.PP
 
260
Definition at line 179 of file qwt_plot_canvas.cpp.
 
261
.SS "void QwtPlotCanvas::invalidatePaintCache ()"
 
262
.PP
 
263
Invalidate the internal paint cache. 
 
264
.PP
 
265
Definition at line 185 of file qwt_plot_canvas.cpp.
 
266
.PP
 
267
Referenced by QwtPlot::replot().
 
268
.SS "void QwtPlotCanvas::paintEvent (QPaintEvent *)\fC [protected, virtual]\fP"
 
269
.PP
 
270
Paint event. 
 
271
.PP
 
272
Definition at line 225 of file qwt_plot_canvas.cpp.
 
273
.PP
 
274
References drawContents().
 
275
.SS "void QwtPlotCanvas::drawContents (QPainter *)\fC [protected, virtual]\fP"
 
276
.PP
 
277
Redraw the canvas, and focus rect. 
 
278
.PP
 
279
Definition at line 250 of file qwt_plot_canvas.cpp.
 
280
.PP
 
281
References QwtPlot::autoReplot(), drawCanvas(), drawFocusIndicator(), focusIndicator(), plot(), and QwtPlot::setAutoReplot().
 
282
.PP
 
283
Referenced by paintEvent().
 
284
.SS "void QwtPlotCanvas::drawFocusIndicator (QPainter *)\fC [protected, virtual]\fP"
 
285
.PP
 
286
Draw the focus indication. 
 
287
.PP
 
288
Definition at line 350 of file qwt_plot_canvas.cpp.
 
289
.PP
 
290
References QwtPainter::drawFocusRect().
 
291
.PP
 
292
Referenced by drawContents().
 
293
.SS "void QwtPlotCanvas::drawCanvas (QPainter * painter = \fCNULL\fP)\fC [protected]\fP"
 
294
.PP
 
295
Draw the the canvas
 
296
.PP
 
297
Paints all plot items to the contentsRect(), using \fBQwtPlot::drawCanvas\fP and updates the paint cache.
 
298
.PP
 
299
\fBSee also:\fP
 
300
.RS 4
 
301
\fBQwtPlot::drawCanvas\fP, setPaintAttributes(), testPaintAttributes() 
 
302
.RE
 
303
.PP
 
304
 
 
305
.PP
 
306
Definition at line 281 of file qwt_plot_canvas.cpp.
 
307
.PP
 
308
Referenced by drawContents().
 
309
 
 
310
.SH "Author"
 
311
.PP 
 
312
Generated automatically by Doxygen for Qwt User's Guide from the source code.