1 files changed, 78 insertions, 8 deletions

diff --git a/libopie/otimepicker.cpp b/libopie/otimepicker.cpp
index 8e8a4e7..115d39b 100644
--- a/libopie/otimepicker.cpp
+++ b/libopie/otimepicker.cpp
@@ -4,27 +4,35 @@
 #include <qtoolbutton.h>
 #include <qlayout.h>
 #include <qstring.h>
 #include <stdio.h>
 #include <qlineedit.h>
 
-OTimePicker::OTimePicker(QWidget* parent, const char* name, 
+
+/**
+ * Constructs the widget
+ * @param parent The parent of the OTimePicker
+ * @param name The name of the object
+ * @param fl Window Flags
+ */
+OTimePicker::OTimePicker(QWidget* parent, const char* name,
                        WFlags fl) :
   QWidget(parent,name,fl)
 {
+
   QVBoxLayout *vbox=new QVBoxLayout(this);
 
   OClickableLabel *r;
   QString s;
 
   // Hour Row
   QWidget *row=new QWidget(this);
   QHBoxLayout *l=new QHBoxLayout(row);
   vbox->addWidget(row);
-  
-  
+
+
   for (int i=0; i<24; i++) {
     r=new OClickableLabel(row);
     hourLst.append(r);
     s.sprintf("%.2d",i);
     r->setText(s);
     r->setToggleButton(true);
@@ -41,13 +49,13 @@ OTimePicker::OTimePicker(QWidget* parent, const char* name,
   }
 
   // Minute Row
   row=new QWidget(this);
   l=new QHBoxLayout(row);
   vbox->addWidget(row);
-  
+
   for (int i=0; i<60; i+=5) {
     r=new OClickableLabel(row);
     minuteLst.append(r);
     s.sprintf("%.2d",i);
     r->setText(s);
     r->setToggleButton(true);
@@ -55,12 +63,20 @@ OTimePicker::OTimePicker(QWidget* parent, const char* name,
     l->addWidget(r);
     connect(r, SIGNAL(toggled(bool)),
             this, SLOT(slotMinute(bool)));
   }
 }
 
+/**
+ * This method return the current time
+ * @return the time
+ */
+QTime OTimePicker::time()const {
+    return tm;
+}
+
 void OTimePicker::slotHour(bool b) {
 
   OClickableLabel *r = (OClickableLabel *) sender();
 
   if (b) {
     QValueListIterator<OClickableLabel *> it;
@@ -89,40 +105,76 @@ void OTimePicker::slotMinute(bool b) {
   } else {
     r->setOn(true);
   }
 
 }
 
+/**
+ * Method to set the time. No signal gets emitted during this method call
+ * Minutes must be within 5 minutes step starting at 0 ( 0,5,10,15,20... )
+ * @param t The time to be set
+ */
+void OTimePicker::setTime( const QTime& t) {
+    setTime( t.hour(), t.minute() );
+}
+
+/**
+ * Method to set the time. No signal gets emitted during this method call
+ * @param h The hour
+ * @param m The minute. Minutes need to set by 5 minute steps
+ */
+void OTimePicker::setTime( int h,  int m ) {
+    setHour(h);
+    setMinute(m);
+}
+
+/*
+ * FIXME round minutes to the 5 minute arrangement -zecke
+ */
+/**
+ * Method to set the minutes
+ * @param m minutes
+ */
 void OTimePicker::setMinute(int m) {
 
   QString minute;
   minute.sprintf("%.2d",m);
 
   QValueListIterator<OClickableLabel *> it;
   for (it=minuteLst.begin(); it!=minuteLst.end(); it++) {
     if ((*it)->text() == minute) (*it)->setOn(true);
     else (*it)->setOn(false);
-  }  
+  }
 
   tm.setHMS(tm.hour(),m,0);
 }
 
+/**
+ * Method to set the hour
+ */
 void OTimePicker::setHour(int h) {
 
   QString hour;
   hour.sprintf("%.2d",h);
 
   QValueListIterator<OClickableLabel *> it;
   for (it=hourLst.begin(); it!=hourLst.end(); it++) {
     if ((*it)->text() == hour) (*it)->setOn(true);
     else (*it)->setOn(false);
-  }  
+  }
   tm.setHMS(h,tm.minute(),0);
 }
 
 
+/**
+ * This is a modal Dialog.
+ *
+ * @param parent The parent widget
+ * @param name The name of the object
+ * @param fl Possible window flags
+ */
 OTimePickerDialog::OTimePickerDialog ( QWidget* parent, const char* name, WFlags fl )
         : OTimePickerDialogBase (parent , name, true , fl)
 {
 
         connect ( m_timePicker, SIGNAL( timeChanged( const QTime& ) ),
                   this, SLOT( setTime ( const QTime& ) ) );
@@ -130,16 +182,24 @@ OTimePickerDialog::OTimePickerDialog ( QWidget* parent, const char* name, WFlags
                   this, SLOT ( setMinute ( const QString& ) ) );
         connect ( hourField, SIGNAL( textChanged ( const QString& ) ),
                   this, SLOT ( setHour ( const QString& ) ) );
 
 }
 
-QTime& OTimePickerDialog::time()
+/**
+ * @return the time
+ */
+QTime OTimePickerDialog::time()const
 {
         return m_time;
 }
+
+/**
+ * Set the time to time
+ * @param time The time to be set
+ */
 void OTimePickerDialog::setTime( const QTime& time )
 {
         m_time = time;
 
         m_timePicker->setHour ( time.hour() );
         m_timePicker->setMinute( time.minute() );
@@ -151,24 +211,34 @@ void OTimePickerDialog::setTime( const QTime& time )
                 hourField->setText( QString::number( time.hour() ) );
 
         if ( time.minute() < 10 )
                 minuteField->setText( "0" + QString::number( time.minute() ) );
         else
                 minuteField->setText( QString::number( time.minute() ) );
-        
+
 }
 
+/**
+ * This method takes the current minute and tries to set hour
+ * to hour. This succeeds if the resulting date is valid
+ * @param hour The hour as a string
+ */
 void OTimePickerDialog::setHour ( const QString& hour )
 {
         if ( QTime::isValid ( hour.toInt(),  m_time.minute() , 00 ) ){
                 m_time.setHMS ( hour.toInt(),  m_time.minute() , 00 );
                 setTime ( m_time );
         }
 
 }
 
+/**
+ * Method to set a new minute. It tries to convert the string to int and
+ * if the resulting date is valid a new date is set.
+ * @see setHour
+ */
 void OTimePickerDialog::setMinute ( const QString& minute )
 {
         if ( QTime::isValid ( m_time.hour(), minute.toInt(), 00 ) ){
                 m_time.setHMS ( m_time.hour(), minute.toInt(), 00 );
                 setTime ( m_time );
         }