summaryrefslogtreecommitdiff
authorzecke <zecke>2004-02-08 15:19:48 (UTC)
committer zecke <zecke>2004-02-08 15:19:48 (UTC)
commitd03af1b4f0e9f00f7d135d4366cac818c6797600 (patch) (side-by-side diff)
tree64e239f1f7134f3e9baadbd18f326112cd59ea60
parenta763515241faab10c9d86c5cb785c714578e9bb0 (diff)
downloadopie-d03af1b4f0e9f00f7d135d4366cac818c6797600.zip
opie-d03af1b4f0e9f00f7d135d4366cac818c6797600.tar.gz
opie-d03af1b4f0e9f00f7d135d4366cac818c6797600.tar.bz2
Add API docu
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--library/alarmserver.cpp60
-rw-r--r--library/dummy_api_docu.cpp58
2 files changed, 118 insertions, 0 deletions
diff --git a/library/alarmserver.cpp b/library/alarmserver.cpp
index a75fc7e..6f6f32d 100644
--- a/library/alarmserver.cpp
+++ b/library/alarmserver.cpp
@@ -318,4 +318,52 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
+ A small example on how to use AlarmServer.
+
+ First we need to connect a slot the AppMessage QCOP call. appMessage
+ will be emitted if QPE/Application/appname gets called.
+
+ \code
+ TestApp::TestApp(QWidget *parent, const char* name, WFlags fl )
+ : QMainWindow(parent,name,fl){
+ connect(qApp,SIGNAL(appMessage(const QCString&,const QByteArray&)),
+ this,SLOT(slotAppMessage(const QCString&,const QByteArray&)));
+ }
+ \endcode
+
+ To add / delete an alarm, you can use the static method AlarmServer::addAlarm and
+ AlarmServer::deleteAlarm. Note that an old (expired) alarm will automatically be deleted
+ from the alarmserver list, but a change in timing will have the effect, that both
+ alarms will be emitted. So if you change an Alarm be sure to delete the old one!
+ @see addAlarm
+
+ \code
+ QDateTime oldDt = oldAlarmDateTime();
+ QPEApplication::execDialog(ourDlg);
+ QDateTime newDt = ourDlg->dateTime();
+ if(newDt == oldDt ) return;
+ @slash* code is missing for unsetting an alarm *@slash
+
+ AlarmServer::deleteAlarm(oldDt,"QPE/Application/appname","checkAlarm(QDateTime,int)",0);
+ AlarmServer::addAlarm( newDt,"QPE/AlarmServer/appname","checkAlarm(QDateTime,int)",0);
+
+ \endcode
+
+ Now once the Alarm is emitted you need to check the appMessage and then do what you want.
+ \code
+ void TestApp::slotAppMessage(const QCString& str, const QByteArray& ar ){
+ QDataStream stream(ar,IO_ReadOnly);
+ if(str == "checkAlarm(QDateTime,int)" ){
+ QDateTime dt;
+ int a;
+ stream >> dt >> a;
+ // fire up alarm
+ }
+ }
+ \endcode
+
\ingroup qtopiaemb
\sa QCopEnvelope
+ @see QPEApplication::appMessage(const QCString&,const QByteArray&)
+ @see OPimMainWindow
+ @see ODevice::alarmSound()
+ @see Sound::soundAlarm()
*/
@@ -331,2 +379,14 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
+ Once an alarm is emitted. The \a channel with a \a message will be emitted
+ and data will be send.
+ The QDateTime and int are the two parameters included in the QCOP message.
+ You can specify channel, message and the integer parameter. QDateTime will be
+ the datetime of the QCop call.
+
+ @param when The QDateTime of the alarm
+ @param channel The channel which gets called once the alarm is emitted
+ @param message The message to be send to the channel
+ @param data Additional data as integer
+
+ @see QCopChannel
\sa deleteAlarm()
diff --git a/library/dummy_api_docu.cpp b/library/dummy_api_docu.cpp
index 6b76401..f2153df 100644
--- a/library/dummy_api_docu.cpp
+++ b/library/dummy_api_docu.cpp
@@ -311 +311,59 @@
*/
+
+
+/**
+ * \class WindowDecorationInterface
+ *
+ * Interface class for Window Decorations. Yu need to implement
+ * metric and drawing functions.
+ */
+
+/**
+ * \class WindowDecorationInterface::WindowData
+ *
+ * Window informations like the QRect, Palette, Caption
+ * and flag
+ */
+
+/**
+ * \fn int WindowDecorationInterface::metric(Metric m,const WindowData* )
+ *
+ * Return the width for the item out of Metric.
+ * Normally you will case Metric and default: should call the interface
+ * method. Also return 0
+ */
+
+/**
+ * \fn void WindowDecorationInterface::drawArea( Area a, QPainter* , const WindowData* )const
+ *
+ * draw the Area specefic in a to the QPainter
+ */
+
+/**
+ * \fn void WindowDecorationInterface::drawButton(Button b,QPainter*p ,const WindowData* d, int x, int y, int w,int h, QWSButton::State s)const
+ *
+ * @param b The Button to be drawn
+ * @param p The painter to draw at
+ * @param d The Window Data
+ * @param x The X position of the button
+ * @param y The Y position of the button
+ * @param w The width of the button
+ * @param h The height of the button
+ * @param s The state of the button
+ */
+
+/**
+ * \fn QRegion WindowDecorationInterface::mask( const WindowData* )const
+ *
+ * The mask of the Decoration.
+ *
+ * \code
+ * int th = metric(TitleHeight,wd);
+ * QRect rect( wd->rect );
+ * QRect r(rect.left() - metric(LeftBorder,wd),
+ * rect.top() - th - metric(TopBorder,wd),
+ * rect.width() + metric(LeftBorder,wd) + metric(RightBorder,wd),
+ * rect.height() + th + metric(TopBorder,wd) + metric(BottomBorder,wd));
+ * return QRegion(r) - rect;
+ * \endcode
+ */