author | zecke <zecke> | 2004-02-06 15:48:42 (UTC) |
---|---|---|
committer | zecke <zecke> | 2004-02-06 15:48:42 (UTC) |
commit | d1c1ce295b6522e52244c970010a9e42c0b614ae (patch) (unidiff) | |
tree | 54e3fefdb0ea998e5c9117f245d6a615ce02200c /library/qpeapplication.h | |
parent | b033733924e5d3454bb0a810c6a70d4ff0531d2b (diff) | |
download | opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.zip opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.gz opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.bz2 |
add api docu
-rw-r--r-- | library/qpeapplication.h | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/library/qpeapplication.h b/library/qpeapplication.h index 729cf2b..3ef8b46 100644 --- a/library/qpeapplication.h +++ b/library/qpeapplication.h | |||
@@ -32,17 +32,55 @@ | |||
32 | #include "qpedecoration_qws.h" | 32 | #include "qpedecoration_qws.h" |
33 | #include "timestring.h" | 33 | #include "timestring.h" |
34 | 34 | ||
35 | class QCopChannel; | 35 | class QCopChannel; |
36 | class QPEApplicationData; | 36 | class QPEApplicationData; |
37 | class QWSEvent; | 37 | class QWSEvent; |
38 | class QWSKeyEvent; | 38 | class QWSKeyEvent; |
39 | 39 | ||
40 | 40 | /** | |
41 | \brief The QPEApplication class implements various system services | ||
42 | that are available to all Qtopia applications. | ||
43 | |||
44 | Simply by using QPEApplication instead of QApplication, a standard Qt | ||
45 | application becomes a Qtopia application. It automatically follows | ||
46 | style changes, quits and raises, and in the | ||
47 | case of \link docwidget.html document-oriented\endlink applications, | ||
48 | changes the currently displayed document in response to the environment. | ||
49 | |||
50 | To create a \link docwidget.html document-oriented\endlink | ||
51 | application use showMainDocumentWidget(); to create a | ||
52 | non-document-oriented application use showMainWidget(). The | ||
53 | keepRunning() function indicates whether the application will | ||
54 | continue running after it's processed the last \link qcop.html | ||
55 | QCop\endlink message. This can be changed using setKeepRunning(). | ||
56 | |||
57 | A variety of signals are emitted when certain events occur, for | ||
58 | example, timeChanged(), clockChanged(), weekChanged(), | ||
59 | dateFormatChanged() and volumeChanged(). If the application receives | ||
60 | a \link qcop.html QCop\endlink message on the application's | ||
61 | QPE/Application/\e{appname} channel, the appMessage() signal is | ||
62 | emitted. There are also flush() and reload() signals, which | ||
63 | are emitted when synching begins and ends respectively - upon these | ||
64 | signals, the application should save and reload any data | ||
65 | files that are involved in synching. Most of these signals will initially | ||
66 | be received and unfiltered through the appMessage() signal. | ||
67 | |||
68 | This class also provides a set of useful static functions. The | ||
69 | qpeDir() and documentDir() functions return the respective paths. | ||
70 | The grabKeyboard() and ungrabKeyboard() functions are used to | ||
71 | control whether the application takes control of the device's | ||
72 | physical buttons (e.g. application launch keys). The stylus' mode of | ||
73 | operation is set with setStylusOperation() and retrieved with | ||
74 | stylusOperation(). There are also setInputMethodHint() and | ||
75 | inputMethodHint() functions. | ||
76 | |||
77 | \ingroup qtopiaemb | ||
78 | */ | ||
41 | class QPEApplication : public QApplication | 79 | class QPEApplication : public QApplication |
42 | { | 80 | { |
43 | Q_OBJECT | 81 | Q_OBJECT |
44 | public: | 82 | public: |
45 | QPEApplication( int& argc, char **argv, Type=GuiClient ); | 83 | QPEApplication( int& argc, char **argv, Type=GuiClient ); |
46 | ~QPEApplication(); | 84 | ~QPEApplication(); |
47 | 85 | ||
48 | static QString qpeDir(); | 86 | static QString qpeDir(); |