summaryrefslogtreecommitdiff
authorzecke <zecke>2004-02-06 15:48:42 (UTC)
committer zecke <zecke>2004-02-06 15:48:42 (UTC)
commitd1c1ce295b6522e52244c970010a9e42c0b614ae (patch) (unidiff)
tree54e3fefdb0ea998e5c9117f245d6a615ce02200c
parentb033733924e5d3454bb0a810c6a70d4ff0531d2b (diff)
downloadopie-d1c1ce295b6522e52244c970010a9e42c0b614ae.zip
opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.gz
opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.bz2
add api docu
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--library/applicationinterface.h33
-rw-r--r--library/fontfactoryinterface.h15
-rw-r--r--library/imagecodecinterface.h13
-rw-r--r--library/qpeapplication.cpp6
-rw-r--r--library/qpeapplication.h40
-rw-r--r--library/styleinterface.h24
6 files changed, 116 insertions, 15 deletions
diff --git a/library/applicationinterface.h b/library/applicationinterface.h
index b37a2c5..b7648f6 100644
--- a/library/applicationinterface.h
+++ b/library/applicationinterface.h
@@ -12,21 +12,54 @@
12 12
13#ifndef QT_NO_COMPONENT 13#ifndef QT_NO_COMPONENT
14// {07E15B48-B947-4334-B866-D2AD58157D8C} 14// {07E15B48-B947-4334-B866-D2AD58157D8C}
15#ifndef IID_QtopiaApplication 15#ifndef IID_QtopiaApplication
16#define IID_QtopiaApplication QUuid( 0x07e15b48, 0xb947, 0x4334, 0xb8, 0x66, 0xd2, 0xad, 0x58, 0x15, 0x7d, 0x8c) 16#define IID_QtopiaApplication QUuid( 0x07e15b48, 0xb947, 0x4334, 0xb8, 0x66, 0xd2, 0xad, 0x58, 0x15, 0x7d, 0x8c)
17#endif 17#endif
18#endif 18#endif
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 */
20struct ApplicationInterface : public QUnknownInterface 37struct ApplicationInterface : public QUnknownInterface
21{ 38{
22public: 39public:
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;
26}; 59};
27 60
28/* 61/*
29 * Use an extended interface for QObejct, Opie::Part in the future 62 * Use an extended interface for QObejct, Opie::Part in the future
30 */ 63 */
31 64
32#endif 65#endif
diff --git a/library/fontfactoryinterface.h b/library/fontfactoryinterface.h
index ed65dfa..68b0be5 100644
--- a/library/fontfactoryinterface.h
+++ b/library/fontfactoryinterface.h
@@ -28,14 +28,29 @@ class QFontFactory;
28 28
29#ifndef QT_NO_COMPONENT 29#ifndef QT_NO_COMPONENT
30// {7F194DD6-FAA3-498F-8F30-9C297A570DFA} 30// {7F194DD6-FAA3-498F-8F30-9C297A570DFA}
31#ifndef IID_FontFactory 31#ifndef IID_FontFactory
32#define IID_FontFactory QUuid( 0x7f194dd6, 0xfaa3, 0x498f, 0x8f, 0x30, 0x9c, 0x29, 0x7a, 0x57, 0x0d, 0xfa) 32#define IID_FontFactory QUuid( 0x7f194dd6, 0xfaa3, 0x498f, 0x8f, 0x30, 0x9c, 0x29, 0x7a, 0x57, 0x0d, 0xfa)
33#endif 33#endif
34#endif 34#endif
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 */
36struct FontFactoryInterface : public QUnknownInterface 51struct FontFactoryInterface : public QUnknownInterface
37{ 52{
38 virtual QFontFactory *fontFactory() = 0; 53 virtual QFontFactory *fontFactory() = 0;
39}; 54};
40 55
41#endif 56#endif
diff --git a/library/imagecodecinterface.h b/library/imagecodecinterface.h
index 8306b68..3b1cd7b 100644
--- a/library/imagecodecinterface.h
+++ b/library/imagecodecinterface.h
@@ -24,16 +24,29 @@
24#include <qpe/qcom.h> 24#include <qpe/qcom.h>
25 25
26#ifndef QT_NO_COMPONENT 26#ifndef QT_NO_COMPONENT
27#ifndef IID_QtopiaImageCodec 27#ifndef IID_QtopiaImageCodec
28#define IID_QtopiaImageCodec QUuid(0x09bf6906, 0x1549, 0xbb4a, 0x18, 0xba, 0xb9, 0xe7, 0x0a, 0x6e, 0x4d, 0x1e) 28#define IID_QtopiaImageCodec QUuid(0x09bf6906, 0x1549, 0xbb4a, 0x18, 0xba, 0xb9, 0xe7, 0x0a, 0x6e, 0x4d, 0x1e)
29#endif 29#endif
30#endif 30#endif
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 **/
32struct ImageCodecInterface : public QUnknownInterface 45struct ImageCodecInterface : public QUnknownInterface
33{ 46{
34public: 47public:
35 virtual QStringList keys() const = 0; 48 virtual QStringList keys() const = 0;
36 virtual bool installIOHandler( const QString &format ) = 0; 49 virtual bool installIOHandler( const QString &format ) = 0;
37}; 50};
38 51
39#endif 52#endif
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp
index a97efc0..6f2e43b 100644
--- a/library/qpeapplication.cpp
+++ b/library/qpeapplication.cpp
@@ -430,18 +430,18 @@ static void setTreble( int t = 0, int percent = -1 )
430 } 430 }
431#endif 431#endif
432 } 432 }
433 break; 433 break;
434 } 434 }
435} 435}
436 436
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
441 that are available to all Qtopia applications. 441 that are available to all Qtopia applications.
442 442
443 Simply by using QPEApplication instead of QApplication, a standard Qt 443 Simply by using QPEApplication instead of QApplication, a standard Qt
444 application becomes a Qtopia application. It automatically follows 444 application becomes a Qtopia application. It automatically follows
445 style changes, quits and raises, and in the 445 style changes, quits and raises, and in the
446 case of \link docwidget.html document-oriented\endlink applications, 446 case of \link docwidget.html document-oriented\endlink applications,
447 changes the currently displayed document in response to the environment. 447 changes the currently displayed document in response to the environment.
@@ -1566,16 +1566,17 @@ void QPEApplication::pidMessage( const QCString& msg, const QByteArray& data)
1566/*! 1566/*!
1567 Sets widget \a mw as the mainWidget() and shows it. For small windows, 1567 Sets widget \a mw as the mainWidget() and shows it. For small windows,
1568 consider passing TRUE for \a nomaximize rather than the default FALSE. 1568 consider passing TRUE for \a nomaximize rather than the default FALSE.
1569 1569
1570 \sa showMainDocumentWidget() 1570 \sa showMainDocumentWidget()
1571*/ 1571*/
1572void QPEApplication::showMainWidget( QWidget* mw, bool nomaximize ) 1572void QPEApplication::showMainWidget( QWidget* mw, bool nomaximize )
1573{ 1573{
1574 setMainWidget(mw);
1574 d->show(mw, nomaximize ); 1575 d->show(mw, nomaximize );
1575} 1576}
1576 1577
1577/*! 1578/*!
1578 Sets widget \a mw as the mainWidget() and shows it. For small windows, 1579 Sets widget \a mw as the mainWidget() and shows it. For small windows,
1579 consider passing TRUE for \a nomaximize rather than the default FALSE. 1580 consider passing TRUE for \a nomaximize rather than the default FALSE.
1580 1581
1581 This calls designates the application as 1582 This calls designates the application as
@@ -1586,16 +1587,17 @@ void QPEApplication::showMainWidget( QWidget* mw, bool nomaximize )
1586 \sa showMainWidget() 1587 \sa showMainWidget()
1587*/ 1588*/
1588void QPEApplication::showMainDocumentWidget( QWidget* mw, bool nomaximize ) 1589void QPEApplication::showMainDocumentWidget( QWidget* mw, bool nomaximize )
1589{ 1590{
1590 if ( mw && argc() == 2 ) 1591 if ( mw && argc() == 2 )
1591 Global::setDocument( mw, QString::fromUtf8(argv()[1]) ); 1592 Global::setDocument( mw, QString::fromUtf8(argv()[1]) );
1592 1593
1593 1594
1595 setMainWidget(mw);
1594 d->show(mw, nomaximize ); 1596 d->show(mw, nomaximize );
1595} 1597}
1596 1598
1597 1599
1598/*! 1600/*!
1599 If an application is started via a \link qcop.html QCop\endlink 1601 If an application is started via a \link qcop.html QCop\endlink
1600 message, the application will process the \link qcop.html 1602 message, the application will process the \link qcop.html
1601 QCop\endlink message and then quit. If the application calls this 1603 QCop\endlink message and then quit. If the application calls this
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
35class QCopChannel; 35class QCopChannel;
36class QPEApplicationData; 36class QPEApplicationData;
37class QWSEvent; 37class QWSEvent;
38class QWSKeyEvent; 38class 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*/
41class QPEApplication : public QApplication 79class QPEApplication : public QApplication
42{ 80{
43 Q_OBJECT 81 Q_OBJECT
44public: 82public:
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();
diff --git a/library/styleinterface.h b/library/styleinterface.h
index 8a900c7..872a4a5 100644
--- a/library/styleinterface.h
+++ b/library/styleinterface.h
@@ -20,48 +20,48 @@
20 20
21#ifndef QT_NO_COMPONENT 21#ifndef QT_NO_COMPONENT
22 22
23// {17AF792C-E461-49A9-9B71-068B9A8DDAE4} 23// {17AF792C-E461-49A9-9B71-068B9A8DDAE4}
24#ifndef IID_Style 24#ifndef IID_Style
25#define IID_Style QUuid( 0x17af792c, 0xe461, 0x49a9, 0x9b, 0x71, 0x06, 0x8b, 0x9a, 0x8d, 0xda, 0xe4) 25#define IID_Style QUuid( 0x17af792c, 0xe461, 0x49a9, 0x9b, 0x71, 0x06, 0x8b, 0x9a, 0x8d, 0xda, 0xe4)
26#endif 26#endif
27 27
28// {6C33B4F9-D529-453A-8FB3-DA42B21872BD} 28// {6C33B4F9-D529-453A-8FB3-DA42B21872BD}
29# ifndef IID_StyleExtended 29# ifndef IID_StyleExtended
30# define IID_StyleExtended QUuid( 0x6c33b4f9, 0xd529, 0x453a, 0x8f, 0xb3, 0xda, 0x42, 0xb2, 0x18, 0x72, 0xbd) 30# define IID_StyleExtended QUuid( 0x6c33b4f9, 0xd529, 0x453a, 0x8f, 0xb3, 0xda, 0x42, 0xb2, 0x18, 0x72, 0xbd)
31#endif 31#endif
32 32
33#endif 33#endif
34 34
35class QWidget; 35class QWidget;
36class QStyle; 36class QStyle;
37 37
38 38
39class QStyle; 39class QStyle;
40 40
41struct StyleInterface : public QUnknownInterface 41struct 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;
47}; 47};
48 48
49struct StyleExtendedInterface : public StyleInterface 49struct 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;
65}; 65};
66 66
67#endif 67#endif