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