summaryrefslogtreecommitdiff
path: root/docs
authorkergoth <kergoth>2002-01-25 22:14:26 (UTC)
committer kergoth <kergoth>2002-01-25 22:14:26 (UTC)
commit15318cad33835e4e2dc620d033e43cd930676cdd (patch) (unidiff)
treec2fa0399a2c47fda8e2cd0092c73a809d17f68eb /docs
downloadopie-15318cad33835e4e2dc620d033e43cd930676cdd.zip
opie-15318cad33835e4e2dc620d033e43cd930676cdd.tar.gz
opie-15318cad33835e4e2dc620d033e43cd930676cdd.tar.bz2
Initial revision
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/README2
-rw-r--r--docs/beauty.html10
-rw-r--r--docs/copying.html336
-rw-r--r--docs/customization.html7
-rw-r--r--docs/developing.html10
-rw-r--r--docs/features.html11
-rw-r--r--docs/i18n.html23
-rw-r--r--docs/index.html17
-rw-r--r--docs/indices.doc152
-rw-r--r--docs/logo32.pngbin0 -> 1857 bytes
-rw-r--r--docs/pointing.html9
-rw-r--r--docs/portability.html9
-rw-r--r--docs/qcop.doc179
-rw-r--r--docs/qt-embedded.html22
-rw-r--r--docs/size.html14
-rw-r--r--docs/source.html8
-rw-r--r--docs/start.doc191
-rw-r--r--docs/support.html9
-rw-r--r--docs/time.html11
-rw-r--r--docs/what.html7
-rw-r--r--docs/writing-handwriting.html7
-rw-r--r--docs/writing-keyboard.html6
-rw-r--r--docs/writing-opti.html4
-rw-r--r--docs/writing-pickboard.html11
-rw-r--r--docs/writing-unicode.html7
-rw-r--r--docs/writing.html13
26 files changed, 1075 insertions, 0 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 0000000..573e0fa
--- a/dev/null
+++ b/docs/README
@@ -0,0 +1,2 @@
1After running qdoc in the directory above, the html directory created here should
2be renamed to "qtopia" and moved to $QTDIR/doc/html/
diff --git a/docs/beauty.html b/docs/beauty.html
new file mode 100644
index 0000000..9cf6509
--- a/dev/null
+++ b/docs/beauty.html
@@ -0,0 +1,10 @@
1<html><head><title>The beauty of Qt/Embedded</title></head><body><h2>The beauty of Qt/Embedded</h2>
2Qt/Embedded features some great additional functionality compared
3to X11. You will be stunned by the beauty of anti-aliased text and alpha
4blended pixmaps. These new features could add an additional touch of class to a
5user interface. Forget about embedded graphics which looks more like old
6alphanumeric terminals. Qt/Embedded can utilize hardware graphics acceleration
7and it is well suited for multimedia and web applications. Let Qt/Embedded
8impress you and your customers.
9</body>
10</html>
diff --git a/docs/copying.html b/docs/copying.html
new file mode 100644
index 0000000..5425ff7
--- a/dev/null
+++ b/docs/copying.html
@@ -0,0 +1,336 @@
1<html><head><title>Copying</title></head><body><h2> Copying</h2>
2
3<p>
4<b>The Qtopia Environment is Copyright &copy; 2000 Trolltech AS.</b>
5
6<p>
7<b>
8 You may use, distribute and copy the Qtopia Environment under the terms of
9 GNU General Public License version 2, which is displayed below.
10</b>
11
12<p>
13<hr>
14
15<h1 align=center>GNU General Public License
16<small>Version 2, June 1991</small>
17</h1>
18
19<p>
20 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
21 675 Mass Ave, Cambridge, MA 02139, USA
22<br>
23 Everyone is permitted to copy and distribute verbatim copies
24 of this license document, but changing it is not allowed.
25
26<h2>Preamble</h2>
27
28<p>
29 The licenses for most software are designed to take away your
30freedom to share and change it. By contrast, the GNU General Public
31License is intended to guarantee your freedom to share and change free
32software--to make sure the software is free for all its users. This
33General Public License applies to most of the Free Software
34Foundation's software and to any other program whose authors commit to
35using it. (Some other Free Software Foundation software is covered by
36the GNU Library General Public License instead.) You can apply it to
37your programs, too.
38
39<p>
40 When we speak of free software, we are referring to freedom, not
41price. Our General Public Licenses are designed to make sure that you
42have the freedom to distribute copies of free software (and charge for
43this service if you wish), that you receive source code or can get it
44if you want it, that you can change the software or use pieces of it
45in new free programs; and that you know you can do these things.
46
47<p>
48 To protect your rights, we need to make restrictions that forbid
49anyone to deny you these rights or to ask you to surrender the rights.
50These restrictions translate to certain responsibilities for you if you
51distribute copies of the software, or if you modify it.
52
53<p>
54 For example, if you distribute copies of such a program, whether
55gratis or for a fee, you must give the recipients all the rights that
56you have. You must make sure that they, too, receive or can get the
57source code. And you must show them these terms so they know their
58rights.
59
60<p>
61 We protect your rights with two steps: (1) copyright the software, and
62(2) offer you this license which gives you legal permission to copy,
63distribute and/or modify the software.
64
65<p>
66 Also, for each author's protection and ours, we want to make certain
67that everyone understands that there is no warranty for this free
68software. If the software is modified by someone else and passed on, we
69want its recipients to know that what they have is not the original, so
70that any problems introduced by others will not reflect on the original
71authors' reputations.
72
73<p>
74 Finally, any free program is threatened constantly by software
75patents. We wish to avoid the danger that redistributors of a free
76program will individually obtain patent licenses, in effect making the
77program proprietary. To prevent this, we have made it clear that any
78patent must be licensed for everyone's free use or not licensed at all.
79
80<p>
81 The precise terms and conditions for copying, distribution and
82modification follow.
83
84
85<h2>GNU General Public License<br>
86Terms and Conditions for Copying, Distribution and Modification
87</h2>
88
89<p>
900. This License applies to any program or other work which contains
91a notice placed by the copyright holder saying it may be distributed
92under the terms of this General Public License. The "Program", below,
93refers to any such program or work, and a "work based on the Program"
94means either the Program or any derivative work under copyright law:
95that is to say, a work containing the Program or a portion of it,
96either verbatim or with modifications and/or translated into another
97language. (Hereinafter, translation is included without limitation in
98the term "modification".) Each licensee is addressed as "you".
99
100<p>
101Activities other than copying, distribution and modification are not
102covered by this License; they are outside its scope. The act of
103running the Program is not restricted, and the output from the Program
104is covered only if its contents constitute a work based on the
105Program (independent of having been made by running the Program).
106Whether that is true depends on what the Program does.
107
108<p>
1091. You may copy and distribute verbatim copies of the Program's
110source code as you receive it, in any medium, provided that you
111conspicuously and appropriately publish on each copy an appropriate
112copyright notice and disclaimer of warranty; keep intact all the
113notices that refer to this License and to the absence of any warranty;
114and give any other recipients of the Program a copy of this License
115along with the Program.
116
117<p>
118You may charge a fee for the physical act of transferring a copy, and
119you may at your option offer warranty protection in exchange for a fee.
120
121<p>
1222. You may modify your copy or copies of the Program or any portion
123of it, thus forming a work based on the Program, and copy and
124distribute such modifications or work under the terms of Section 1
125above, provided that you also meet all of these conditions:
126
127<p>
128a) You must cause the modified files to carry prominent notices
129stating that you changed the files and the date of any change.
130
131<p>
132b) You must cause any work that you distribute or publish, that in
133whole or in part contains or is derived from the Program or any
134part thereof, to be licensed as a whole at no charge to all third
135parties under the terms of this License.
136
137<p>
138c) If the modified program normally reads commands interactively
139when run, you must cause it, when started running for such
140interactive use in the most ordinary way, to print or display an
141announcement including an appropriate copyright notice and a
142notice that there is no warranty (or else, saying that you provide
143a warranty) and that users may redistribute the program under
144these conditions, and telling the user how to view a copy of this
145License. (Exception: if the Program itself is interactive but
146does not normally print such an announcement, your work based on
147the Program is not required to print an announcement.)
148
149<p>
150These requirements apply to the modified work as a whole. If
151identifiable sections of that work are not derived from the Program,
152and can be reasonably considered independent and separate works in
153themselves, then this License, and its terms, do not apply to those
154sections when you distribute them as separate works. But when you
155distribute the same sections as part of a whole which is a work based
156on the Program, the distribution of the whole must be on the terms of
157this License, whose permissions for other licensees extend to the
158entire whole, and thus to each and every part regardless of who wrote it.
159
160<p>
161Thus, it is not the intent of this section to claim rights or contest
162your rights to work written entirely by you; rather, the intent is to
163exercise the right to control the distribution of derivative or
164collective works based on the Program.
165
166<p>
167In addition, mere aggregation of another work not based on the Program
168with the Program (or with a work based on the Program) on a volume of
169a storage or distribution medium does not bring the other work under
170the scope of this License.
171
172<p>
1733. You may copy and distribute the Program (or a work based on it,
174under Section 2) in object code or executable form under the terms of
175Sections 1 and 2 above provided that you also do one of the following:
176
177<p>
178a) Accompany it with the complete corresponding machine-readable
179source code, which must be distributed under the terms of Sections
1801 and 2 above on a medium customarily used for software interchange; or,
181
182<p>
183b) Accompany it with a written offer, valid for at least three
184years, to give any third party, for a charge no more than your
185cost of physically performing source distribution, a complete
186machine-readable copy of the corresponding source code, to be
187distributed under the terms of Sections 1 and 2 above on a medium
188customarily used for software interchange; or,
189
190<p>
191c) Accompany it with the information you received as to the offer
192to distribute corresponding source code. (This alternative is
193allowed only for non-commercial distribution and only if you
194received the program in object code or executable form with such
195an offer, in accord with Subsection b above.)
196
197<p>
198The source code for a work means the preferred form of the work for
199making modifications to it. For an executable work, complete source
200code means all the source code for all modules it contains, plus any
201associated interface definition files, plus the scripts used to
202control compilation and installation of the executable. However, as a
203special exception, the source code distributed need not include
204anything that is normally distributed (in either source or binary
205form) with the major components (compiler, kernel, and so on) of the
206operating system on which the executable runs, unless that component
207itself accompanies the executable.
208
209<p>
210If distribution of executable or object code is made by offering
211access to copy from a designated place, then offering equivalent
212access to copy the source code from the same place counts as
213distribution of the source code, even though third parties are not
214compelled to copy the source along with the object code.
215
216<p>
2174. You may not copy, modify, sublicense, or distribute the Program
218except as expressly provided under this License. Any attempt
219otherwise to copy, modify, sublicense or distribute the Program is
220void, and will automatically terminate your rights under this License.
221However, parties who have received copies, or rights, from you under
222this License will not have their licenses terminated so long as such
223parties remain in full compliance.
224
225<p>
2265. You are not required to accept this License, since you have not
227signed it. However, nothing else grants you permission to modify or
228distribute the Program or its derivative works. These actions are
229prohibited by law if you do not accept this License. Therefore, by
230modifying or distributing the Program (or any work based on the
231Program), you indicate your acceptance of this License to do so, and
232all its terms and conditions for copying, distributing or modifying
233the Program or works based on it.
234
235<p>
2366. Each time you redistribute the Program (or any work based on the
237Program), the recipient automatically receives a license from the
238original licensor to copy, distribute or modify the Program subject to
239these terms and conditions. You may not impose any further
240restrictions on the recipients' exercise of the rights granted herein.
241You are not responsible for enforcing compliance by third parties to
242this License.
243
244<p>
2457. If, as a consequence of a court judgement or allegation of patent
246infringement or for any other reason (not limited to patent issues),
247conditions are imposed on you (whether by court order, agreement or
248otherwise) that contradict the conditions of this License, they do not
249excuse you from the conditions of this License. If you cannot
250distribute so as to satisfy simultaneously your obligations under this
251License and any other pertinent obligations, then as a consequence you
252may not distribute the Program at all. For example, if a patent
253license would not permit royalty-free redistribution of the Program by
254all those who receive copies directly or indirectly through you, then
255the only way you could satisfy both it and this License would be to
256refrain entirely from distribution of the Program.
257
258<p>
259If any portion of this section is held invalid or unenforceable under
260any particular circumstance, the balance of the section is intended to
261apply and the section as a whole is intended to apply in other
262circumstances.
263
264<p>
265It is not the purpose of this section to induce you to infringe any
266patents or other property right claims or to contest validity of any
267such claims; this section has the sole purpose of protecting the
268integrity of the free software distribution system, which is
269implemented by public license practices. Many people have made
270generous contributions to the wide range of software distributed
271through that system in reliance on consistent application of that
272system; it is up to the author/donor to decide if he or she is willing
273to distribute software through any other system and a licensee cannot
274impose that choice.
275
276<p>
277This section is intended to make thoroughly clear what is believed to
278be a consequence of the rest of this License.
279
280<p>
2818. If the distribution and/or use of the Program is restricted in
282certain countries either by patents or by copyrighted interfaces, the
283original copyright holder who places the Program under this License
284may add an explicit geographical distribution limitation excluding
285those countries, so that distribution is permitted only in or among
286countries not thus excluded. In such case, this License incorporates
287the limitation as if written in the body of this License.
288
289<p>
2909. The Free Software Foundation may publish revised and/or new versions
291of the General Public License from time to time. Such new versions will
292be similar in spirit to the present version, but may differ in detail to
293address new problems or concerns.
294
295<p>
296Each version is given a distinguishing version number. If the Program
297specifies a version number of this License which applies to it and "any
298later version", you have the option of following the terms and conditions
299either of that version or of any later version published by the Free
300Software Foundation. If the Program does not specify a version number of
301this License, you may choose any version ever published by the Free Software
302Foundation.
303
304<p>
30510. If you wish to incorporate parts of the Program into other free
306programs whose distribution conditions are different, write to the author
307to ask for permission. For software which is copyrighted by the Free
308Software Foundation, write to the Free Software Foundation; we sometimes
309make exceptions for this. Our decision will be guided by the two goals
310of preserving the free status of all derivatives of our free software and
311of promoting the sharing and reuse of software generally.
312
313<p>
314NO WARRANTY
315
316<p>
31711. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
318FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
319OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
320PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
321OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
322MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
323TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
324PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
325REPAIR OR CORRECTION.
326
327<p>
32812. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
329WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
330REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
331INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
332OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
333TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
334YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
335PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
336POSSIBILITY OF SUCH DAMAGES.
diff --git a/docs/customization.html b/docs/customization.html
new file mode 100644
index 0000000..ce586a8
--- a/dev/null
+++ b/docs/customization.html
@@ -0,0 +1,7 @@
1<html><head><title>Customization</title></head><body><h2>Customization</h2>
2Qt's clean object oriented design makes it easy to extend and
3enhance the standard widgets. You can create specialized widgets for the
4limited space offered by embedded device screens.
5Qt's GUI styling support lets you create a unique GUI look to make your
6device stand out from the rest.
7
diff --git a/docs/developing.html b/docs/developing.html
new file mode 100644
index 0000000..f6f3eed
--- a/dev/null
+++ b/docs/developing.html
@@ -0,0 +1,10 @@
1<html><head><title>Developing</title></head><body><h2> Developing</h2>
2To add functionality to the Qtopia Environment, download the
3sourcecode to both Qt/Embedded and the Qtopia Environment
4from Trolltech's website (http://www.trolltech.com). The API used
5is the same as normal Qt for X11 and Windows, so you can choose to
6develop your applications there first, but keep in mind the much
7smaller screen size that the Qtopia Environment is intended
8to be used on.
9</body>
10</html>
diff --git a/docs/features.html b/docs/features.html
new file mode 100644
index 0000000..5df6576
--- a/dev/null
+++ b/docs/features.html
@@ -0,0 +1,11 @@
1<html><head><title>Features</title></head><body><h2>Features</h2>
2<ol>
3<li>Alpha-blending of image painting
4<li>Anti-aliased scalable TrueType and Type1 fonts
5<li>Small memory-mapped pre-rendered fonts
6<li>Handwriting recognition, virtual keyboard
7<li>Easy to write new input methods
8<li>Easy to add new client-side rendering
9</ol>
10</body>
11</html>
diff --git a/docs/i18n.html b/docs/i18n.html
new file mode 100644
index 0000000..f47ca1f
--- a/dev/null
+++ b/docs/i18n.html
@@ -0,0 +1,23 @@
1<html><head><title>I18n</title></head><body><h2> <img src=language.png> I18n</h2>
2Qt/Embedded uses Unicode natively.
3(some characters below may noit be present in the current font)
4<p>
5<font face=Cyberbit size=4>
6语言 : 简体中文
7<p>
8語言 : 繁體中文
9<p>
10Γλώσσα: Ελληνικά
11<p>
12Langage: Français
13<p>
14言語 : 日本語
15<p>
16언어 : 한국어
17<p>
18Язык: Русский
19<p>
20Språk: Norsk
21</font>
22</body>
23</html>
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..f70f7e1
--- a/dev/null
+++ b/docs/index.html
@@ -0,0 +1,17 @@
1<html><head><title>Welcome to Qtopia</title></head>
2<body>
3
4<p align=center><img src=qtlogo.png height=100>
5<h3 align=center>Qtopia</h3>
6<p align=center><small>Made with <a href=qt-embedded.html>Qt/Embedded</a> from Trolltech</small></center>
7
8<p align=center>
9<table width=100% border=0 cellspacing=2><tr>
10<td align=center><a href="pointing.html">Pointing</a></td>
11<td align=center><a href="writing.html">Writing</a></td>
12</tr><tr>
13<td align=center><a href="developing.html">Developing</a></td>
14<td align=center><a href="copying.html">Copying</a></td>
15</tr></table>
16
17</body></html>
diff --git a/docs/indices.doc b/docs/indices.doc
new file mode 100644
index 0000000..8da9c31
--- a/dev/null
+++ b/docs/indices.doc
@@ -0,0 +1,152 @@
1/*!
2
3\page index.html
4
5\title Qtopia - the Qt palmtop environment
6
7Qtopia is a graphical environment for Linux on a handheld PC or small device.
8
9<ul>
10 <li><a href=start.html>Getting started with Qtopia development</a>
11 <li><a href=refman.html>Qtopia Library Reference Manual</a>
12 <li><a href=../index.html>Qt Library Reference Manual</a>
13</ul>
14
15*/
16
17/*!
18
19\page refman.html
20
21\title Qtopia Library Reference Manual
22
23<h2>Overview</h2>
24
25Qtopia applications share a common look and feel through a shared application
26framework. This documentation describes that framework to the audience
27of developers intending to write new applications and to modify existing
28applications.
29
30<ul>
31 <li> <a href=mainfunc.html>The <tt>main()</tt> function.</a>
32 <li> <a href=docwidget.html>The main document widget.</a>
33 <li> <a href=qcop.html>QCop messages.</a>
34 <li> <a href=classes.html>Library classes.</a>
35 <li> <a href=functions.html>All functions.</a>
36</ul>
37*/
38
39/*!
40
41\page mainfunc.html
42
43\title The <tt>main()</tt> function
44
45The <tt>main()</tt> function of all applications should following
46this example:
47
48\code
49int main( int argc, char **argv )
50{
51 QPEApplication a( argc, argv );
52
53 Main m;
54 a.showMainWidget(&m);
55
56 a.exec();
57}
58\endcode
59
60If the application is <a href=docwidget.html>document-oriented</a>, the
61call to <tt>QPEApplication::showMainWidget()</tt>
62should be replaced by a call to
63<tt>\l QPEApplication::showMainDocumentWidget() </tt>.
64
65The application window should be implemented in a self-contained way -
66it should not perform application-level operations such as testing parameters,
67calling exit(), or calling quit() - all that is handled by QPEApplication.
68Your application window should call close() if it needs to explicitly
69close, and it must be prepared for the possibility that show() will be
70called before the application window destructor. In other words,
71implement your application window in a way that it could be used easily
72from other applications - and that is a good rule to follow anyway, as
73it means that most of your program can be trivially reused on Qt/X11, Qt/Windows,
74Qt/Mac, and any other ports of the Qt API.
75*/
76
77/*!
78
79\page docwidget.html
80
81\title The main document widget
82
83Applications which view or edit a particular type or types of files are
84called <i>document-oriented</i> applications. Qtopia has framework
85support to simplify the implementation of such applications. The
86<a href=mainfunc.html>main()</a> function is slightly different in
87these applications.
88
89The top-level widget of a document-oriented application must have a
90Qt slot named:
91
92\code
93public slot:
94 void setDocument( const QString& applnk_filename );
95\endcode
96
97This slot should then be implemented to save the applications current
98document (if any) and show/edit the specified document. An example
99implementation is:
100
101\code
102void Main::setDocument( const QString& applnk_filename )
103{
104 FileManager fm;
105
106 if ( current ) {
107 if ( !fm.saveFile( *current, data ) ) {
108 // error
109 return;
110 }
111 delete current;
112 }
113
114 current = new DocLnk(applnk_filename);
115
116 if ( !fm.loadFile(*current, data ) ) {
117 // error
118 }
119}
120\endcode
121
122*/
123
124/*!
125
126\page classes.html
127
128\title Library Classes
129
130\annotatedclasslist
131
132*/
133
134/*!
135
136\page headers.html
137
138\title Header Files
139
140\headerfilelist
141
142*/
143
144/*!
145
146\page functions.html
147
148\title All Functions
149
150\functionindex
151
152*/
diff --git a/docs/logo32.png b/docs/logo32.png
new file mode 100644
index 0000000..92b7b73
--- a/dev/null
+++ b/docs/logo32.png
Binary files differ
diff --git a/docs/pointing.html b/docs/pointing.html
new file mode 100644
index 0000000..9830188
--- a/dev/null
+++ b/docs/pointing.html
@@ -0,0 +1,9 @@
1<html><head><title>Pointing</title></head><body><h2> Pointing</h2>
2When using a stylus or a mouse, press-and-hold rather than tapping or clicking
3on an item to activate additional functionality, such as a menu of options.
4<p>
5For example, in the Mine Sweep game, press-and-hold to mark the location of
6a bomb. In the File Browser, press-and-hold on a filename to choose an
7operation to perform on the file.
8</body>
9</html>
diff --git a/docs/portability.html b/docs/portability.html
new file mode 100644
index 0000000..a4b891f
--- a/dev/null
+++ b/docs/portability.html
@@ -0,0 +1,9 @@
1<html><head><title>Portability</title></head><body><h2>Portability</h2>
2Qt/Embedded features the same API as the excellent
3Qt/Windows and Qt/X11 versions. Imagine writing your Qt application in
4your favourite desktop environment and just recompiling to move it to
5your embedded device. It saves you heaps of development effort and
6allows you to work productively in your favorite programming
7environment from day one. You can start today.
8</body>
9</html>
diff --git a/docs/qcop.doc b/docs/qcop.doc
new file mode 100644
index 0000000..6fe4c71
--- a/dev/null
+++ b/docs/qcop.doc
@@ -0,0 +1,179 @@
1/*!
2
3\page qcop.html
4
5\title QCop Messages
6
7QCop messages allow applications to communicate with each other.
8These messages are send using QCopEnvelope, and received by connecting
9to a QCopChannel.
10
11The <tt>channelname</tt> of channels within Qtopia all start with "QPE/".
12The <tt>messagename</tt> is a function identifier followed by a list of types
13in parentheses. There are no spaces in the message name.
14
15The variable names shown in this documentation are purely for information
16purposes. A message shown as
17"messageName(Type1 varname1, Type2 varname2, Type2 varname3)" would be
18used in program code as:
19
20\code
21 QCopEnvelope e(channelname, "messageName(Type1,Type2,Type2)");
22 e << parameter1 << parameter2 << parameter3;
23\endcode
24
25
26The system-wide channels and messages.
27
28<dl>
29<dt><b>QPE/System</b>
30 <dd>
31 <ul>
32 <li>busy()
33 <br> Causes a wait indicator to be shown to the user.
34 <li>notBusy()
35 <br> Cancels the wait indicator.
36 <li>linkChanged(QString)
37 <br> Sent whenever a link is changed.
38 It is sent by FileManager::saveFile() and others, and
39 received by the Launcher.
40 <li>applyStyle()
41 <br> Sent when user changes style.
42 It is received by QPEApplication and the application
43 will redraw accordingly.
44 <li>quit()
45 <br> Terminates the Qtopia environment.
46 <li>shutdown()
47 <br> Terminates the system.
48 <li>restart()
49 <br> Restarts the Qtopia environment.
50 <li>execute(QString)
51 <br> Executes or raises the given application.
52 <li>execute(QString,QString)
53 <br> Executes or raises the given application, passing an argument.
54 Note that you should consider using the
55 <b>QPE/Application/<i>appname</i></b> channels described below.
56 <li>addAlarm(QDateTime,QCString,QCString,int)
57 <br> Internal. See AlarmServer::addAlarm()
58 <li>deleteAlarm(QDateTime,QCString,QCString,int)
59 <br> Internal. See AlarmServer::deleteAlarm()
60 <li>setDefaultRotation(int)
61 <br> Internal.
62 <li>grabKeyboard(QString)
63 <br> Internal.
64 <li>timeChange(QString)
65 <br> Internal.
66 <li>clockChange(bool)
67 <br> Internal.
68 <li>setScreenSaverInterval(int)
69 <br> Internal.
70 <li>language(QString)
71 <br> Internal.
72 </ul>
73
74<dt><b>QPE/Sync</b>
75 <ul>
76 <li>flush()
77 <br> Sent at the start of synchronization. Synchable applications
78 should save any synchable data to disk.
79 <i>Note: this message is currently asynchronous. Stay tuned
80 to discussions regarding synchronization, as this message
81 may become synchronous, requiring slight midification to
82 your code. For now, just respond in a timely fashion,
83 since the sync server merely waits a small time.</i>
84 <li>reload()
85 <br> Sent at the end of synchronization. Synchable applications
86 should reload any synchable data from disk.
87 </ul>
88
89<dt><b>QPE/TaskBar</b>
90 <ul>
91 <li>message(QString)
92 <br> Internal. See Global::statusMessage()
93 <li>showInputMethod()
94 <br> Internal.
95 <li>hideInputMethod()
96 <br> Internal.
97 <li>reloadInputMethods()
98 <br> Internal.
99 <li>reloadApplets()
100 <br> Internal.
101 </ul>
102
103<dt><b>QPE/Card</b>
104 <ul>
105 <li>stabChanged()
106 <br> Sent when <tt>/var/run/stab</tt>, <tt>/var/state/pcmcia/stab</tt>,
107 or <tt>/var/lib/pcmcia/stab</tt> may have changed.
108 <li>netUp()
109 <br> Sent when a network connection is running.
110 <li>netDown()
111 <br> Sent when a network connection is available, but not running.
112 <li>netUnavailable()
113 <br> Sent when a network connection is not available.
114 </ul>
115
116<dt><b>Qt/Tray</b>
117 This channel allows Qt applications (not just Qtopia applications)
118 to show system-tray status in a cross-platform manner,
119 but it is not currently supported. See TaskbarAppletInterface for
120 a more powerful alternative for system tray applications.
121 <ul>
122 <li>popup(int,QPoint)
123 <li>remove(int)
124 <li>setIcon(int,QPixmap)
125 <li>setToolTip(int,QString)
126 <li>doubleClicked(int,QPoint)
127 <li>clicked(int,QPoint)
128 </ul>
129</dl>
130
131Each application listens on a channel called
132<b>QPE/Application/<i>appname</i></b>, where <b><i>appname</i></b> is
133the executable name (the application identifier). Standard messages on
134this channel are:
135
136<dl>
137 <dt><b>QPE/Application/<i>appname</i></b>
138 <ul>
139 <li>setDocument(QString)
140 <br>Internal. Causes the setDocument(const QString&) slot
141 of <a href=docwidget.html>the main document widget</a>
142 to be called.
143 <li>nextView()
144 <br>Applications connected to hardware buttons will receive
145 this message if they are already visible.
146 <li>raise()
147 <br>Internal. Causes the the main document widget and the
148 current modal widget to be raised.
149 <li>quit()
150 <br>Internal. Terminates the application.
151 <li>quitIfInvisible()
152 <br>Internal. Terminates the application if it is not shown.
153 </ul>
154</dl>
155
156The QPE/Application/<i>appname</i> channel has a special property: when
157messages are sent to these channels vie QCopEnvelope, the message is
158delivered even if the application is not yet running (the application
159is run and the message is then sent).
160
161Applications also respond to messages specific to the application.
162Such messages in the base Qtopia applications are:
163
164<dl>
165 <dt><b>QPE/Application/helpbrowser</b>
166 <ul>
167 <li>showFile(QString <i>file</i>)
168 <br>Send this message to have the Help Browser show a file.
169 The <i>file</i> may be an absolute filename or relative
170 to the system HTML documentation directory ($QPEDIR/help/html).
171 </ul>
172 <dt><b>QPE/Application/datebook</b>
173 <ul>
174 <li>alarm(QDateTime,int)
175 <br>Internal. Causes the Calendar application to sound alarms.
176 </ul>
177</dl>
178
179*/
diff --git a/docs/qt-embedded.html b/docs/qt-embedded.html
new file mode 100644
index 0000000..2180be6
--- a/dev/null
+++ b/docs/qt-embedded.html
@@ -0,0 +1,22 @@
1<html><head><title>Welcome to Qtopia</title></head>
2<body>
3
4<p align=center><img src=qtlogo.png height=100>
5<h3 align=center><a href=index.html>The Qtopia Environment</a></h3>
6<p align=center><small>Made with Qt/Embedded from Trolltech</small></center>
7
8<p align=center>
9<table width=100% border=0 cellspacing=2><tr>
10<td align=center><a href="size.html">Small</a></td>
11<td align=center><a href="features.html">Feature-packed</a></td>
12</tr><tr>
13<td align=center><a href="customization.html">Customizable</a></td>
14<td align=center><a href="portability.html">Portable</a></td>
15</tr><tr>
16<td align=center><a href="support.html">Support</a></td>
17<td align=center><a href="source.html">Open Source</a></td>
18</tr><tr>
19<td align=center><a href="i18n.html">International</a></td>
20</tr></table>
21
22</body></html>
diff --git a/docs/size.html b/docs/size.html
new file mode 100644
index 0000000..813f283
--- a/dev/null
+++ b/docs/size.html
@@ -0,0 +1,14 @@
1<html><head><title>Size</title></head><body><h2> <img src=tgz.xpm> Size</h2>
2Qt/Embedded is modular and scalable. You can assemble the
3Qt features you really need and leave the others out.
4<p>
5Qt/Embedded includes the GUI server, client libraries, and window manager.
6<p>
7By picking and choosing features, the memory demands of
8Qt/Embedded can be tuned between 800Kb and 3 Mb in ROM (Intel x86).
9<p>
10Applications written with Qt have a small
11memory footprint compared to applications written with other toolkits
12due to sharing of the rich feature-set in the library.
13</body>
14</html>
diff --git a/docs/source.html b/docs/source.html
new file mode 100644
index 0000000..019a0b1
--- a/dev/null
+++ b/docs/source.html
@@ -0,0 +1,8 @@
1<html><head><title>Source Code</title></head><body><h2>Source Code</h2>
2You know the value of source code availability. All Qt
3releases are delivered with source code, and Qt/Embedded is no exception.
4You get a better understanding of how Qt works and it helps you debug
5and tune your code. Customer and community feedback allows us to continually
6improve the source code for better usability and performance.
7</body>
8</html
diff --git a/docs/start.doc b/docs/start.doc
new file mode 100644
index 0000000..9745d9a
--- a/dev/null
+++ b/docs/start.doc
@@ -0,0 +1,191 @@
1/*!
2
3\page start.html
4
5\title Getting Started
6
7<html>
8<title>Qtopia - The Qt palmtop environment</title>
9
10<body>
11<h1><i>Qtopia</i> - The Qt palmtop environment</h1>
12
13<p>
14<i>Qtopia</i> is a windowing system for handheld devices. It offers
15developers the powerful Qt API, and provides users with fast and
16intuitive interaction.
17
18<h2>Developing for <i>Qtopia</i></h2>
19
20<p>
21The Qt API includes rich GUI functionality, and is suitable for
22both large and small applications.
23
24<p>
25Since <i>Qtopia</i> offers the complete Qt API, you can do much of
26your development on any of the other platforms for which Qt is
27available - Windows, Unix/X11, or Mac OS X. However, for optimal
28tailoring of your application to the smaller screen and other
29demands of a handheld environment, you should use the <i>Qtopia
30SDK</i>.
31
32<p>
33The <i>Qtopia SDK</i> allows you to develop <i>Qtopia</i>
34applications under the Linux desktop environment using the Qt Virtual
35Framebuffer, which completely emulates the handheld <i>Qtopia</i>
36environment. It also includes cross-compiler software so that you can
37compile your application to run on the target handheld device.
38If you do not already have the Qtopia SDK (this document is normally
39part of the SDK), contact info@trolltech.com, or see the
40<a href=http://www.trolltech.com>Trolltech</a> web site.
41
42<p>To build applications for the SHARP SL5000 or similar StrongARM-based devices,
43you will also need a StrongARM cross compiler. Entrants in the programming
44contest for this device will have received both the SDK and a cross-compiler.
45
46<p>
47The SDK includes an example program. We recommend that you compile and
48run this example to learn how things work, before tackling your own
49projects.
50
51<p>
52To compile the example program for running on the Linux desktop:
53
54<ol>
55 <li>
56 <p>
57 Check the environment is correct:
58
59 <p>
60<pre>
61 export QPEDIR=/opt/Qtopia
62 export QTDIR=/opt/Qtopia
63 export PATH=$QTDIR/bin:$PATH
64 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-generic-g++
65 export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH
66</pre>
67
68 <li> Take a copy of the example:
69
70<pre>
71 cd somewhere
72 cp -r $QPEDIR/example .
73 cd example
74</pre>
75
76 <li> Generate a Makefile:
77
78<pre>
79 tmake -o Makefile example.pro
80</pre>
81
82 <li> Build the example:
83
84<pre>
85 make
86</pre>
87
88 <li> Install it:
89
90<pre>
91 su # root privileges required to install
92 cp example.desktop $QPEDIR/apps/Applications
93 cp Example.png $QPEDIR/pics
94 cp example $QPEDIR/bin
95 exit # no need to be root anymore
96</pre>
97
98 <li> To run it, first run the Qt Virtual Framebuffer:
99
100<pre>
101 qvfb &amp;
102</pre>
103
104 <li> Then run the <i>Qtopia</i> environment:
105
106<pre>
107 qpe
108</pre>
109
110<p>
111 Your application should be available in the Applications tab visible
112inside the Qt Virtual Framebuffer window.
113</p>
114
115 <li> If you want to distribute your applications to others, build an RPM package, e.g.:
116<pre>
117 mkipks -rpm -arch i386 example.control
118</pre>
119</ol>
120
121<p>
122To make your own application, use the example program as a model. Make sure that
123when you add files to your project, you also add them
124to your project file (e.g. <tt>example.pro</tt>) and rerun the
125<tt>tmake</tt> command to update the <tt>Makefile</tt>.
126
127<p>
128To build you application for the SHARP SL5000 rather than just running
129on the desktop, the process is similar:
130
131<ol>
132 <li>
133 <p>
134 Check the environment is correctly set for the SHARP SL5000:
135
136 <p>
137<pre>
138 export QPEDIR=/opt/Qtopia/sharp
139 export QTDIR=/opt/Qtopia/sharp
140 export PATH=$QTDIR/bin:/usr/local/arm/bin:$PATH
141 export TMAKEPATH=/opt/Qtopia/tmake/lib/qws/linux-sharp-g++
142</pre>
143
144 <li> Build and install exactly the same as you did for the desktop
145 (note that the generated Makefile is different):
146<pre>
147 make clean
148 tmake -o Makefile example.pro
149 ... <i>etc.</i>
150</pre>
151
152 <li> To install it on a device, build an ipk package file (you should be root
153 to do this, since then it will strip the executable for you):
154<pre>
155 mkipks example.control
156</pre>
157
158<p>
159 The resulting <tt>example-1.0.0.ipk</tt> can be installed on the
160SL5000 by using <i>Qtopia Desktop</i>.
161</p>
162
163</ol>
164
165<h3>Building Your Own Applications</h3>
166
167Once you have built the example, you can proceed with writing
168your own applicatons. If you are not familiar with Qt, you should
169consult the Qt documentation by pointing your web browser at
170<a href=file:/opt/Qtopia/doc/html/index.html><tt>/opt/Qtopia/doc/html/index.html</tt></a>
171when you have installed the SDK, or use the online
172<a href=http://doc.trolltech.com/>Trolltech Documentation Site</a>.
173The <a href="http://www.trolltech.com/products/qt/whitepaper.html">Qt
174Whitepaper</a> provides a good overview of, and introduction to, the
175Qt API.
176
177<p>
178When you add more files to your application, just edit the project
179file (e.g. <tt>example.pro</tt>) and rerun the <tt>tmake</tt>
180command.
181
182<p>
183The <tt>.ui</tt> files are <i>Qt Designer</i> user interface files.
184You can create and edit these using <i>Qt Designer</i>:
185<pre>
186 designer example.ui
187</pre>
188<i>Qt Designer</i>'s online documentation includes a complete
189tutorial.
190
191*/
diff --git a/docs/support.html b/docs/support.html
new file mode 100644
index 0000000..7d6a930
--- a/dev/null
+++ b/docs/support.html
@@ -0,0 +1,9 @@
1<html><head><title>Support</title></head><body><h2>Support</h2>
2Embedded devices have different requirements to desktop
3computers. The Qt/Embedded team at Trolltech is dedicated to supporting you with
4new features and widgets. We can offer training, partnerships and first class
5support. It is straightforward to port Qt/Embedded to new hardware. We can
6offer you a port to your special device or the embedded operating system of
7your choice. We look forward to working closely with you to help you succeed.
8</body>
9</html>
diff --git a/docs/time.html b/docs/time.html
new file mode 100644
index 0000000..3c6cc2f
--- a/dev/null
+++ b/docs/time.html
@@ -0,0 +1,11 @@
1<html><head><title>Time to market</title></head><body><h2>Time to market</h2>
2Qt is one of the most popular GUI toolkits in the world.
3Programmers like the compact code,the powerful API, the ease of use, and the
4excellent support. It is easy to find existing developer skills with Qt and a
5lot of quality Qt based code has already been written. Qt/Embedded allows you
6and your programmers to move seamlessly into the exciting field of embedded
7systems. Your Qt experts don't need to be retrained. Our customers tell us that
8even programmers without Qt experience get up to speed sooner with Qt than with
9other toolkits.
10</body>
11</html>
diff --git a/docs/what.html b/docs/what.html
new file mode 100644
index 0000000..bfff3a9
--- a/dev/null
+++ b/docs/what.html
@@ -0,0 +1,7 @@
1<html><head><title>What is Qt/Embedded?</title></head><body><h2>What is Qt/Embedded?</h2>
2The Qt/Embedded product provides you with all you need to
3create stunning graphical user interfaces for embedded devices.
4Qt/Embedded installs and runs with a very small memory footprint on any
5device running embedded Linux - without using X11.
6</body>
7</html>
diff --git a/docs/writing-handwriting.html b/docs/writing-handwriting.html
new file mode 100644
index 0000000..cc493d7
--- a/dev/null
+++ b/docs/writing-handwriting.html
@@ -0,0 +1,7 @@
1<html><head><title>Handwriting</title></head><body><h2>Handwriting</h2>
2By combining handwriting recognition with the dictionary, you can enter
3words with even fairly sloppy writing. The default handwriting templates
4should suit most people, or you can also edit them from the pencil icon
5on the handwriting input panel.
6</body>
7</html>
diff --git a/docs/writing-keyboard.html b/docs/writing-keyboard.html
new file mode 100644
index 0000000..dc734a7
--- a/dev/null
+++ b/docs/writing-keyboard.html
@@ -0,0 +1,6 @@
1<html><head><title>Keyboard</title></head><body><h2>Keyboard</h2>
2The legacy input device. Not at all suited to small devices.
3It is static like a lump of plastic
4(except for the little green arrow and the dictionary look-ahead).
5</body>
6</html>
diff --git a/docs/writing-opti.html b/docs/writing-opti.html
new file mode 100644
index 0000000..faf8d26
--- a/dev/null
+++ b/docs/writing-opti.html
@@ -0,0 +1,4 @@
1<html><head><title>Opti</title></head><body><h2>Opti</h2>
2This is an experimental input method.
3</body>
4</html>
diff --git a/docs/writing-pickboard.html b/docs/writing-pickboard.html
new file mode 100644
index 0000000..62db4ff
--- a/dev/null
+++ b/docs/writing-pickboard.html
@@ -0,0 +1,11 @@
1<html><head><title>Pickboard</title></head><body><h2>Pickboard</h2>
2The Pickboard is a neat invention of Trolltech's that makes use of the
3dynamic nature of a palmtop display to provide reasonably fast text input
4using a minimum of screen space.
5<p>
6Tap anywhere on the letter-group containing the letter you want to type,
7and QPE searches the dictionary (very fast) to find matching words.
8<p>
9Tap the words to "type" them.
10</body>
11</html>
diff --git a/docs/writing-unicode.html b/docs/writing-unicode.html
new file mode 100644
index 0000000..5396258
--- a/dev/null
+++ b/docs/writing-unicode.html
@@ -0,0 +1,7 @@
1<html><head><title>Unicode</title></head><body><h2>Unicode</h2>
2This method allows you to input any character from the Unicode
3range. Of course, it's only appropriate for very occasional use!
4Having this requires a somewhat large font, the GNU UniFont, which
5is supplied with Qt/Embedded.
6</body>
7</html>
diff --git a/docs/writing.html b/docs/writing.html
new file mode 100644
index 0000000..49d6fc9
--- a/dev/null
+++ b/docs/writing.html
@@ -0,0 +1,13 @@
1<html><head><title>Writing</title></head><body><h2>Writing</h2>
2To enter text without a keyboard, tap on the icon to the right of the
3<img src=go.png> menu. This brings up one of the input methods. The
4small arrow further to the right brings up a menu of different methods.
5<ul>
6<li><a href=writing-pickboard.html>Pickboard</a>
7<li><a href=writing-handwriting.html>Handwriting</a>
8<li><a href=writing-keyboard.html>Keyboard</a>
9<li><a href=writing-opti.html>Opti</a>
10<li><a href=writing-unicode.html>Unicode</a>
11</ul>
12</body>
13</html>