summaryrefslogtreecommitdiff
path: root/library/applicationinterface.h
authorzecke <zecke>2004-02-06 15:48:42 (UTC)
committer zecke <zecke>2004-02-06 15:48:42 (UTC)
commitd1c1ce295b6522e52244c970010a9e42c0b614ae (patch) (side-by-side diff)
tree54e3fefdb0ea998e5c9117f245d6a615ce02200c /library/applicationinterface.h
parentb033733924e5d3454bb0a810c6a70d4ff0531d2b (diff)
downloadopie-d1c1ce295b6522e52244c970010a9e42c0b614ae.zip
opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.gz
opie-d1c1ce295b6522e52244c970010a9e42c0b614ae.tar.bz2
add api docu
Diffstat (limited to 'library/applicationinterface.h') (more/less context) (show whitespace changes)
-rw-r--r--library/applicationinterface.h33
1 files changed, 33 insertions, 0 deletions
diff --git a/library/applicationinterface.h b/library/applicationinterface.h
index b37a2c5..b7648f6 100644
--- a/library/applicationinterface.h
+++ b/library/applicationinterface.h
@@ -16,13 +16,46 @@
#define IID_QtopiaApplication QUuid( 0x07e15b48, 0xb947, 0x4334, 0xb8, 0x66, 0xd2, 0xad, 0x58, 0x15, 0x7d, 0x8c)
#endif
#endif
+
+/**
+ * \brief Application interface currently used by the quicklaunch framework
+ *
+ * This is the interface to be exposed by applications available as DSO
+ * Normally one would use the OApplicationFactory which does the magic of
+ * exposing the interface.
+ *
+ *
+ * Resulting dynamic shared objects (dso) need to go into the
+ * OPIEDIR/plugins/application.
+ *
+ *
+ * You can use this interface to load applications into your application.
+ * @todo Implement Services + Trader
+ * @since Opie 1.0.2
+ */
struct ApplicationInterface : public QUnknownInterface
{
public:
+
+ /**
+ * \brief create the mainwindow for the giving application name
+ * Create a main window for the giving application name
+ *
+ * @param appName The application widget to be created
+ * @param parent The parent of the newly created widget
+ * @param name The name of the QObject
+ * @param f Possible Window Flags
+ *
+ * @return the widget or 0l
+ */
virtual QWidget *createMainWindow( const QString &appName, QWidget *parent=0,
const char *name=0, Qt::WFlags f=0 ) = 0;
+
+ /**
+ * The list of application windows supported
+ */
virtual QStringList applications() const = 0;
};
/*