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 | |
parent | b033733924e5d3454bb0a810c6a70d4ff0531d2b (diff) | |
download | opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.zip opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.gz opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.bz2 |
add api docu
-rw-r--r-- | library/applicationinterface.h | 33 | ||||
-rw-r--r-- | library/fontfactoryinterface.h | 15 | ||||
-rw-r--r-- | library/imagecodecinterface.h | 13 | ||||
-rw-r--r-- | library/qpeapplication.cpp | 6 | ||||
-rw-r--r-- | library/qpeapplication.h | 40 | ||||
-rw-r--r-- | library/styleinterface.h | 14 |
6 files changed, 111 insertions, 10 deletions
diff --git a/library/applicationinterface.h b/library/applicationinterface.h index b37a2c5..b7648f6 100644 --- a/library/applicationinterface.h +++ b/library/applicationinterface.h | |||
@@ -19,2 +19,19 @@ | |||
19 | 19 | ||
20 | |||
21 | /** | ||
22 | * \brief Application interface currently used by the quicklaunch framework | ||
23 | * | ||
24 | * This is the interface to be exposed by applications available as DSO | ||
25 | * Normally one would use the OApplicationFactory which does the magic of | ||
26 | * exposing the interface. | ||
27 | * | ||
28 | * | ||
29 | * Resulting dynamic shared objects (dso) need to go into the | ||
30 | * OPIEDIR/plugins/application. | ||
31 | * | ||
32 | * | ||
33 | * You can use this interface to load applications into your application. | ||
34 | * @todo Implement Services + Trader | ||
35 | * @since Opie 1.0.2 | ||
36 | */ | ||
20 | struct ApplicationInterface : public QUnknownInterface | 37 | struct ApplicationInterface : public QUnknownInterface |
@@ -22,4 +39,20 @@ struct ApplicationInterface : public QUnknownInterface | |||
22 | public: | 39 | public: |
40 | |||
41 | /** | ||
42 | * \brief create the mainwindow for the giving application name | ||
43 | * Create a main window for the giving application name | ||
44 | * | ||
45 | * @param appName The application widget to be created | ||
46 | * @param parent The parent of the newly created widget | ||
47 | * @param name The name of the QObject | ||
48 | * @param f Possible Window Flags | ||
49 | * | ||
50 | * @return the widget or 0l | ||
51 | */ | ||
23 | virtual QWidget *createMainWindow( const QString &appName, QWidget *parent=0, | 52 | virtual QWidget *createMainWindow( const QString &appName, QWidget *parent=0, |
24 | const char *name=0, Qt::WFlags f=0 ) = 0; | 53 | const char *name=0, Qt::WFlags f=0 ) = 0; |
54 | |||
55 | /** | ||
56 | * The list of application windows supported | ||
57 | */ | ||
25 | virtual QStringList applications() const = 0; | 58 | virtual QStringList applications() const = 0; |
diff --git a/library/fontfactoryinterface.h b/library/fontfactoryinterface.h index ed65dfa..68b0be5 100644 --- a/library/fontfactoryinterface.h +++ b/library/fontfactoryinterface.h | |||
@@ -35,2 +35,17 @@ class QFontFactory; | |||
35 | 35 | ||
36 | |||
37 | /** | ||
38 | * \brief Interface for additional Font Factories | ||
39 | * | ||
40 | * To add special types of fonts TrueTypes or your very own | ||
41 | * format. If you implement this Interface you can add | ||
42 | * custom font loading. | ||
43 | * | ||
44 | * The dynamic shared object goes to | ||
45 | * OPIEDIR/plugins/fontfactories. | ||
46 | * | ||
47 | * As of version Opie 1.0.2 loading of the plugins is not | ||
48 | * yet implemented | ||
49 | * | ||
50 | */ | ||
36 | struct FontFactoryInterface : public QUnknownInterface | 51 | struct FontFactoryInterface : public QUnknownInterface |
diff --git a/library/imagecodecinterface.h b/library/imagecodecinterface.h index 8306b68..3b1cd7b 100644 --- a/library/imagecodecinterface.h +++ b/library/imagecodecinterface.h | |||
@@ -31,2 +31,15 @@ | |||
31 | 31 | ||
32 | |||
33 | /** | ||
34 | * | ||
35 | * \brief add Image Codecs | ||
36 | * | ||
37 | * This interface will be queried to add new Image loading | ||
38 | * and saving routines. | ||
39 | * | ||
40 | * The ImageCodec needs to be placed in OPIEDIR/plugins/imagecodecs. | ||
41 | * | ||
42 | * @see QImage | ||
43 | * @see QImageIO | ||
44 | **/ | ||
32 | struct ImageCodecInterface : public QUnknownInterface | 45 | struct ImageCodecInterface : public QUnknownInterface |
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp index a97efc0..6f2e43b 100644 --- a/library/qpeapplication.cpp +++ b/library/qpeapplication.cpp | |||
@@ -437,4 +437,4 @@ static void setTreble( int t = 0, int percent = -1 ) | |||
437 | 437 | ||
438 | /*! | 438 | /** |
439 | \class QPEApplication qpeapplication.h | 439 | \class QPEApplication |
440 | \brief The QPEApplication class implements various system services | 440 | \brief The QPEApplication class implements various system services |
@@ -1573,2 +1573,3 @@ void QPEApplication::showMainWidget( QWidget* mw, bool nomaximize ) | |||
1573 | { | 1573 | { |
1574 | setMainWidget(mw); | ||
1574 | d->show(mw, nomaximize ); | 1575 | d->show(mw, nomaximize ); |
@@ -1593,2 +1594,3 @@ void QPEApplication::showMainDocumentWidget( QWidget* mw, bool nomaximize ) | |||
1593 | 1594 | ||
1595 | setMainWidget(mw); | ||
1594 | d->show(mw, nomaximize ); | 1596 | d->show(mw, nomaximize ); |
diff --git a/library/qpeapplication.h b/library/qpeapplication.h index 729cf2b..3ef8b46 100644 --- a/library/qpeapplication.h +++ b/library/qpeapplication.h | |||
@@ -39,3 +39,41 @@ 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 |
diff --git a/library/styleinterface.h b/library/styleinterface.h index 8a900c7..872a4a5 100644 --- a/library/styleinterface.h +++ b/library/styleinterface.h | |||
@@ -42,5 +42,5 @@ struct StyleInterface : public QUnknownInterface | |||
42 | { | 42 | { |
43 | //! Return a new style. | 43 | /*! Return a new style.*/ |
44 | virtual QStyle *style() = 0; | 44 | virtual QStyle *style() = 0; |
45 | //! Return a short name for the style. | 45 | /*! Return a short name for the style. */ |
46 | virtual QString name() const = 0; | 46 | virtual QString name() const = 0; |
@@ -50,15 +50,15 @@ struct StyleExtendedInterface : public StyleInterface | |||
50 | { | 50 | { |
51 | //! Return a (longer) description for the style. | 51 | /*! Return a (longer) description for the style. */ |
52 | virtual QString description ( ) const = 0; | 52 | virtual QString description ( ) const = 0; |
53 | 53 | ||
54 | //! Does this style support customization | 54 | /*! Does this style support customization */ |
55 | virtual bool hasSettings ( ) const = 0; | 55 | virtual bool hasSettings ( ) const = 0; |
56 | 56 | ||
57 | //! Return a new settings page. | 57 | /*! Return a new settings page. */ |
58 | virtual QWidget *create ( QWidget *parent, const char *name = 0 ) = 0; | 58 | virtual QWidget *create ( QWidget *parent, const char *name = 0 ) = 0; |
59 | 59 | ||
60 | //! Callback for appearance app when OK is clicked (return true when style has to re-applied). | 60 | /*! Callback for appearance app when OK is clicked (return true when style has to re-applied). */ |
61 | virtual bool accept ( ) = 0; | 61 | virtual bool accept ( ) = 0; |
62 | 62 | ||
63 | //! Callback for appeaeance app when Cancel is clicked. | 63 | /*! Callback for appeaeance app when Cancel is clicked. */ |
64 | virtual void reject ( ) = 0; | 64 | virtual void reject ( ) = 0; |