| -rw-r--r-- | docs/indices.doc | 152 |
1 files changed, 152 insertions, 0 deletions
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 + +*/ |