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

« back to all changes in this revision

Viewing changes to qwt-5.1.1/doc/qwt.dox

  • 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:
 
1
/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 
2
 * Qwt Widget Library
 
3
 * Copyright (C) 1997   Josef Wilgen
 
4
 * Copyright (C) 2002   Uwe Rathmann
 
5
 *
 
6
 * This library is free software; you can redistribute it and/or
 
7
 * modify it under the terms of the Qwt License, Version 1.0
 
8
 *****************************************************************************/
 
9
 
 
10
/*
 
11
  This file contains NO source code, just some documentation for doxygen to
 
12
  parse.
 
13
*/
 
14
 
 
15
/*!
 
16
  \mainpage Qwt - Qt Widgets for Technical Applications
 
17
 
 
18
The Qwt library contains GUI Components and utility classes which are primarily
 
19
useful for programs with a technical background. Beside a 2D plot widget
 
20
it provides scales, sliders, dials, compasses, thermometers, wheels and knobs 
 
21
to control or display values, arrays, or ranges of type double.
 
22
 
 
23
  \image html plot.png
 
24
 
 
25
  \if homepage
 
26
  \section homepage Project page
 
27
  The official project page is hosted at 
 
28
        <a href="http://qwt.sourceforge.net">sourceforge</a>
 
29
  \endif
 
30
 
 
31
  \section license License
 
32
 
 
33
  Qwt is distributed under the terms of the \ref qwtlicense.
 
34
 
 
35
  \section platforms Platforms
 
36
 
 
37
  Qwt 5.x might be usable in all environments where you find
 
38
  <a href="http://www.trolltech.com/products/qt">Qt</a>.
 
39
  It is compatible with Qt 3.3.x and Qt 4.x, but the documentation
 
40
  is generated for Qt 4.x.\n
 
41
 
 
42
  \section screenshotsonmainpage Screenshots
 
43
  - \ref curvescreenshots\n
 
44
  - \ref scatterscreenshots\n
 
45
  - \ref spectrogramscreenshots\n
 
46
  - \ref histogramscreenshots\n
 
47
  - \ref controlscreenshots\n
 
48
 
 
49
  \latexonly Screenshots are only available in the HTML docs.\endlatexonly
 
50
 
 
51
  \section downloads Downloads
 
52
  Stable releases, prereleases and snapshots are available at the Qwt <a href="http://sourceforge.net/projects/qwt">project page</a>.
 
53
 
 
54
  Qwt doesn't distribute binary packages, but below is a incomplete list
 
55
  of packagers :
 
56
<a href="http://packages.qa.debian.org/q/qwt.html">Debian</a>,
 
57
  <a href="http://packman.links2linux.de/package/libqwt5">S.u.S.E</a>,
 
58
  <a href="ftp://open-gnss.org/pub/fedora/qwt">Fedora</a>,
 
59
  <a href="http://packages.gentoo.org/packages/?category=x11-libs;name=qwt">Gentoo</a>. 
 
60
  <a href="http://pdb.finkproject.org/pdb/package.php/qwt">Fink</a>. 
 
61
  <a href="http://packages.ubuntu.com/cgi-bin//search_packages.pl?version=all&subword=0&exact=1&arch=any&releases=all&case=insensitive&keywords=qwt&searchon=sourcenames">Ubuntu</a>. 
 
62
 
 
63
  For getting a 5.2 development snapshot from the SVN repository: 
 
64
  \code svn co https://qwt.svn.sourceforge.net/svnroot/qwt/trunk/qwt \endcode
 
65
 
 
66
  For getting a snapshot with all bugfixes for the latest 5.1 release:
 
67
  \code svn co https://qwt.svn.sourceforge.net/svnroot/qwt/branches/qwt-5.1 \endcode
 
68
 
 
69
  \section installonmainpage Installation
 
70
 
 
71
  Have a look at the qwt.pro project file. It is prepared for building
 
72
  dynamic libraries in Win32 and Unix/X11 environments. 
 
73
  If you don't know what to do with it, read the file \ref qwtinstall and/or 
 
74
  Trolltechs 
 
75
  <a href="http://www.trolltech.com/developer/documentation/index.html">qmake</a> documentation. Once you have build the library you have to install 
 
76
  all files from the lib, include and doc directories.
 
77
 
 
78
  \section support Support
 
79
  - Mailing list\n
 
80
  For all kind of Qwt related questions use the Qwt <a href="http://sourceforge.net/mail/?group_id=13693">mailing list</a>.\n 
 
81
  If you prefer newsgroups use the mail to news gateway of <a href="http://dir.gmane.org/gmane.comp.graphics.qwt.general">Gmane</a>. 
 
82
 
 
83
  - Forum\n
 
84
  <a href="http://www.qtcentre.org">Qt Centre</a> is a great resource for Qt
 
85
  related questions. It has a sub forum, that is dedicated to
 
86
  Qwt related questions.
 
87
 
 
88
  - Individual support\n
 
89
  If you are looking for individual support, or need someone who implements 
 
90
  your Qwt component/application contact qwt-support@tigertal.de.
 
91
 
 
92
  \section relatedprojects Related Projects
 
93
 
 
94
  <a href="http://qwtpolar.sourceforge.net">QwtPolar</a>, a polar plot widget.\n
 
95
  <a href="http://qwtplot3d.sourceforge.net">QwtPlot3D</a>, an OpenGL 3D plot widget.\n
 
96
  <a href="http://soft.proindependent.com/qtiplot.html">QtiPlot</a>, 
 
97
  data analysis and scientific plotting tool, using QwtPlot.
 
98
 
 
99
  \section languagebindings Language Bindings
 
100
 
 
101
  <a href="http://pyqwt.sourceforge.net">PyQwt</a>, a set of Qwt Python bindings.\n
 
102
  <a href="http://rubyforge.org/projects/korundum/">Korundum/QtRuby</a>, including a set of Qwt Ruby bindings.\n
 
103
 
 
104
  \section donations Donations
 
105
 
 
106
  Sourceforge offers a <a href="http://sourceforge.net/docman/display_doc.php?docid=20244&group_id=1"> Donation System</a> via PayPal. You can use it, if you like to <a href="http://sourceforge.net/project/project_donations.php?group_id=13693">support</a> the development of Qwt.
 
107
 
 
108
  \section credits Credits:
 
109
  \par Authors: 
 
110
    Uwe Rathmann, Josef Wilgen ( <= Qwt 0.2 )
 
111
  \par Project admin:
 
112
    Uwe Rathmann \<rathmann@users.sourceforge.net\>
 
113
*/
 
114
 
 
115
/*!
 
116
  \page qwtlicense Qwt License, Version 1.0
 
117
  \include "COPYING"
 
118
*/
 
119
 
 
120
/*!
 
121
  \page qwtinstall INSTALL
 
122
  \include "INSTALL"
 
123
*/
 
124
 
 
125
/*!
 
126
  \page curvescreenshots Curve Plots
 
127
  \image html plot.png 
 
128
 
 
129
  \image html sinus.png 
 
130
 
 
131
  \image html cpuplot.png 
 
132
 
 
133
  \image html graph.png 
 
134
 
 
135
  \image html curves.png 
 
136
*/
 
137
 
 
138
/*!
 
139
  \page scatterscreenshots Scatter Plot
 
140
  \image html scatterplot.png 
 
141
*/
 
142
 
 
143
/*!
 
144
  \page spectrogramscreenshots Spectrogram, Contour Plot
 
145
  \image html spectrogram1.png 
 
146
 
 
147
  \image html spectrogram2.png 
 
148
 
 
149
  \image html spectrogram3.png 
 
150
 
 
151
/*!
 
152
  \page histogramscreenshots Histogram
 
153
  \image html histogram.png 
 
154
*/
 
155
 
 
156
/*!
 
157
  \page controlscreenshots Dials, Compasses, Knobs, Wheels, Sliders, Thermos
 
158
  \image html radio.png
 
159
 
 
160
  \image html sliders.png
 
161
 
 
162
  \image html dials1.png
 
163
 
 
164
  \image html dials2.png
 
165
 
 
166
  \image html sysinfo.png
 
167
*/