-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 @@ | |||
1 | /*! | ||
2 | |||
3 | \page index.html | ||
4 | |||
5 | \title Qtopia - the Qt palmtop environment | ||
6 | |||
7 | Qtopia 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 | |||
25 | Qtopia applications share a common look and feel through a shared application | ||
26 | framework. This documentation describes that framework to the audience | ||
27 | of developers intending to write new applications and to modify existing | ||
28 | applications. | ||
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 | |||
45 | The <tt>main()</tt> function of all applications should following | ||
46 | this example: | ||
47 | |||
48 | \code | ||
49 | int 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 | |||
60 | If the application is <a href=docwidget.html>document-oriented</a>, the | ||
61 | call to <tt>QPEApplication::showMainWidget()</tt> | ||
62 | should be replaced by a call to | ||
63 | <tt>\l QPEApplication::showMainDocumentWidget() </tt>. | ||
64 | |||
65 | The application window should be implemented in a self-contained way - | ||
66 | it should not perform application-level operations such as testing parameters, | ||
67 | calling exit(), or calling quit() - all that is handled by QPEApplication. | ||
68 | Your application window should call close() if it needs to explicitly | ||
69 | close, and it must be prepared for the possibility that show() will be | ||
70 | called before the application window destructor. In other words, | ||
71 | implement your application window in a way that it could be used easily | ||
72 | from other applications - and that is a good rule to follow anyway, as | ||
73 | it means that most of your program can be trivially reused on Qt/X11, Qt/Windows, | ||
74 | Qt/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 | |||
83 | Applications which view or edit a particular type or types of files are | ||
84 | called <i>document-oriented</i> applications. Qtopia has framework | ||
85 | support to simplify the implementation of such applications. The | ||
86 | <a href=mainfunc.html>main()</a> function is slightly different in | ||
87 | these applications. | ||
88 | |||
89 | The top-level widget of a document-oriented application must have a | ||
90 | Qt slot named: | ||
91 | |||
92 | \code | ||
93 | public slot: | ||
94 | void setDocument( const QString& applnk_filename ); | ||
95 | \endcode | ||
96 | |||
97 | This slot should then be implemented to save the applications current | ||
98 | document (if any) and show/edit the specified document. An example | ||
99 | implementation is: | ||
100 | |||
101 | \code | ||
102 | void 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 | */ | ||