summaryrefslogtreecommitdiff
authorzecke <zecke>2004-02-16 15:11:17 (UTC)
committer zecke <zecke>2004-02-16 15:11:17 (UTC)
commit7993db150b2c0a616e6cc15107c8570095c3f125 (patch) (side-by-side diff)
tree329549246592cdd7a5e3adf25e89abb53e6e8e57
parent1a8d80152aca9be46cb3b8c64218b3dc72d2147e (diff)
downloadopie-7993db150b2c0a616e6cc15107c8570095c3f125.zip
opie-7993db150b2c0a616e6cc15107c8570095c3f125.tar.gz
opie-7993db150b2c0a616e6cc15107c8570095c3f125.tar.bz2
more api docu
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--library/qpedialog.cpp28
-rw-r--r--library/qpedialog.h8
2 files changed, 36 insertions, 0 deletions
diff --git a/library/qpedialog.cpp b/library/qpedialog.cpp
index b98e42e..ac42972 100644
--- a/library/qpedialog.cpp
+++ b/library/qpedialog.cpp
@@ -25,6 +25,27 @@
#include "qpedialog.h"
#include <qpe/qpeapplication.h>
+
+/**
+ * \brief This is the only c'tor.
+ *
+ * The parent of this Listener is the Dialog you pass. This means once
+ * the dialog is deleted this listener will be deleted too.
+ * This Listener listens on QPEApplication::appMessage signal and implements
+ * accept() and reject().
+ *
+ * \code
+ * QDialog *dialog = new YourDialog();
+ (void)new QPEDialogListener(dialog);
+ if( QPEApplication::execDialog(dialog) == QDialog::Accept ){
+ // do some stuff
+ }
+ delete dialog;
+
+ * \endcode
+ *
+ * @param di The dialog to handle
+ */
QPEDialogListener::QPEDialogListener(QDialog *di ) : QObject(di)
{
dialog = di;
@@ -32,8 +53,15 @@ QPEDialogListener::QPEDialogListener(QDialog *di ) : QObject(di)
this, SLOT(appMessage(const QCString&, const QByteArray&)) );
}
+
+/**
+ * d'tor
+ */
QPEDialogListener::~QPEDialogListener() {}
+/**
+ * \internal
+ */
void QPEDialogListener::appMessage( const QCString &msg, const QByteArray & )
{
if (!dialog)
diff --git a/library/qpedialog.h b/library/qpedialog.h
index ed77720..1e35efd 100644
--- a/library/qpedialog.h
+++ b/library/qpedialog.h
@@ -24,6 +24,14 @@
class QPEDialogListenerData;
+/**
+ * \brief Listen on QCOP messages to accept/reject a dialog.
+ *
+ * If you want your dialog to be acceptables/rejectable by QCOP
+ * You need to create a QPEDialogListener with your Dialog as Argument.
+ *
+ * This feature is at least use with the first use support of Opie
+ */
class QPEDialogListener : public QObject
{
Q_OBJECT