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

« back to all changes in this revision

Viewing changes to doc/man/man3/QwtSeriesData.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2011-06-10 11:22:47 UTC
  • mfrom: (1.1.6 upstream) (2.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20110610112247-0i1019vvmzaq6p86
Tags: 6.0.0-1
* New upstream release (Closes: #624107):
  - drop Qt3 support. (Closes: #604379, #626868)
* Register documentation with doc-base. (Closes: #626567)
* Drop patches:
  - 01_makefiles.diff
  - 02_add_missing_warnings.diff
  - 03_qwt_branch_pull_r544.diff
* Add qwt_install_paths.patch to fix the hardcoded installation paths.
* Update debian/control:
  - drop libqt3-mt-dev build dependency.
  - bump Standards-Version to 3.9.2 (no changes).
  - drop Qt3 related packages.
  - due to bump soname (and as we dropper Qt3 support):
    - libqwt5-qt4-dev -> libqwt-dev
    - libqwt5-qt4 -> libqwt6
    - libqwt5-doc -> libqwt-doc
* Update debian/copyright file.
* Update debian/rules: drop Qt3 packages support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "QwtSeriesData" 3 "Fri Apr 15 2011" "Version 6.0.0" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtSeriesData \- 
 
6
.PP
 
7
Abstract interface for iterating over samples.  
 
8
 
 
9
.SH SYNOPSIS
 
10
.br
 
11
.PP
 
12
.PP
 
13
\fC#include <qwt_series_data.h>\fP
 
14
.PP
 
15
Inherited by \fBQwtArraySeriesData< T >\fP.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtSeriesData\fP ()"
 
21
.br
 
22
.ti -1c
 
23
.RI "virtual \fB~QwtSeriesData\fP ()"
 
24
.br
 
25
.ti -1c
 
26
.RI "virtual size_t \fBsize\fP () const =0"
 
27
.br
 
28
.ti -1c
 
29
.RI "virtual T \fBsample\fP (size_t i) const =0"
 
30
.br
 
31
.ti -1c
 
32
.RI "virtual QRectF \fBboundingRect\fP () const =0"
 
33
.br
 
34
.ti -1c
 
35
.RI "virtual void \fBsetRectOfInterest\fP (const QRectF &)"
 
36
.br
 
37
.in -1c
 
38
.SS "Protected Attributes"
 
39
 
 
40
.in +1c
 
41
.ti -1c
 
42
.RI "QRectF \fBd_boundingRect\fP"
 
43
.br
 
44
.in -1c
 
45
.SH "Detailed Description"
 
46
.PP 
 
47
 
 
48
.SS "template<typename T> class QwtSeriesData< T >"
 
49
Abstract interface for iterating over samples. 
 
50
 
 
51
Qwt offers several implementations of the \fBQwtSeriesData\fP API, but in situations, where data of an application specific format needs to be displayed, without having to copy it, it is recommended to implement an individual data access. 
 
52
.SH "Constructor & Destructor Documentation"
 
53
.PP 
 
54
.SS "template<typename T > \fBQwtSeriesData\fP< T >::\fBQwtSeriesData\fP ()"
 
55
.PP
 
56
Constructor. 
 
57
.SS "template<typename T > \fBQwtSeriesData\fP< T >::~\fBQwtSeriesData\fP ()\fC [virtual]\fP"
 
58
.PP
 
59
Destructor. 
 
60
.SH "Member Function Documentation"
 
61
.PP 
 
62
.SS "template<typename T> virtual QRectF \fBQwtSeriesData\fP< T >::boundingRect () const\fC [pure virtual]\fP"Calculate the bounding rect of all samples
 
63
.PP
 
64
The bounding rect is necessary for autoscaling and can be used for a couple of painting optimizations.
 
65
.PP
 
66
qwtBoundingRect(...) offers slow implementations iterating over the samples. For large sets it is recommended to implement something faster f.e. by caching the bounding rect. 
 
67
.PP
 
68
Implemented in \fBQwtPointSeriesData\fP, \fBQwtPoint3DSeriesData\fP, \fBQwtIntervalSeriesData\fP, \fBQwtSetSeriesData\fP, \fBQwtPointArrayData\fP, \fBQwtCPointerData\fP, and \fBQwtSyntheticPointData\fP.
 
69
.SS "template<typename T> virtual T \fBQwtSeriesData\fP< T >::sample (size_ti) const\fC [pure virtual]\fP"Return a sample 
 
70
.PP
 
71
\fBParameters:\fP
 
72
.RS 4
 
73
\fIi\fP Index 
 
74
.RE
 
75
.PP
 
76
\fBReturns:\fP
 
77
.RS 4
 
78
Sample at position i 
 
79
.RE
 
80
.PP
 
81
 
 
82
.PP
 
83
Implemented in \fBQwtArraySeriesData< T >\fP, \fBQwtPointArrayData\fP, \fBQwtCPointerData\fP, \fBQwtSyntheticPointData\fP, \fBQwtArraySeriesData< QwtIntervalSample >\fP, \fBQwtArraySeriesData< QPointF >\fP, \fBQwtArraySeriesData< QwtPoint3D >\fP, and \fBQwtArraySeriesData< QwtSetSample >\fP.
 
84
.SS "template<typename T > void \fBQwtSeriesData\fP< T >::setRectOfInterest (const QRectF &)\fC [virtual]\fP"Set a the 'rect of interest'
 
85
.PP
 
86
\fBQwtPlotSeriesItem\fP defines the current area of the plot canvas as 'rect of interest' ( \fBQwtPlotSeriesItem::updateScaleDiv()\fP ). It can be used to implement different levels of details.
 
87
.PP
 
88
The default implementation does nothing. 
 
89
.PP
 
90
Reimplemented in \fBQwtSyntheticPointData\fP.
 
91
.SS "template<typename T> virtual size_t \fBQwtSeriesData\fP< T >::size () const\fC [pure virtual]\fP"\fBReturns:\fP
 
92
.RS 4
 
93
Number of samples 
 
94
.RE
 
95
.PP
 
96
 
 
97
.PP
 
98
Implemented in \fBQwtArraySeriesData< T >\fP, \fBQwtPointArrayData\fP, \fBQwtCPointerData\fP, \fBQwtSyntheticPointData\fP, \fBQwtArraySeriesData< QwtIntervalSample >\fP, \fBQwtArraySeriesData< QPointF >\fP, \fBQwtArraySeriesData< QwtPoint3D >\fP, and \fBQwtArraySeriesData< QwtSetSample >\fP.
 
99
.SH "Member Data Documentation"
 
100
.PP 
 
101
.SS "template<typename T> QRectF \fBQwtSeriesData\fP< T >::\fBd_boundingRect\fP\fC [mutable, protected]\fP"
 
102
.PP
 
103
Can be used to cache a calculated bounding rectangle. 
 
104
 
 
105
.SH "Author"
 
106
.PP 
 
107
Generated automatically by Doxygen for Qwt User's Guide from the source code.