Jumbo API documentation update

and some API fixed
ColorDialog is now OColorDialog!!! keep the namespace tidy!
ColorPopupMenu is now OColorPopupMenu!!! keep the namespace tidy
ColorDialog TT couldn't break bc we can so make it const QColor&
OTimePicker add some convience methods

more I might have forgot

1 files changed, 71 insertions, 1 deletions

diff --git a/libopie/otimepicker.cpp b/libopie/otimepicker.cpp
index 8e8a4e7..115d39b 100644
--- a/libopie/otimepicker.cpp
+++ b/libopie/otimepicker.cpp
@@ -8,8 +8,16 @@
 #include <qlineedit.h>
 
+
+/**
+ * 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);
 
@@ -59,4 +67,12 @@ OTimePicker::OTimePicker(QWidget* parent, const char* name,
 }
 
+/**
+ * This method return the current time
+ * @return the time
+ */
+QTime OTimePicker::time()const {
+    return tm;
+}
+
 void OTimePicker::slotHour(bool b) {
 
@@ -93,4 +109,30 @@ void OTimePicker::slotMinute(bool b) {
 }
 
+/**
+ * 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) {
 
@@ -107,4 +149,7 @@ void OTimePicker::setMinute(int m) {
 }
 
+/**
+ * Method to set the hour
+ */
 void OTimePicker::setHour(int h) {
 
@@ -121,4 +166,11 @@ void OTimePicker::setHour(int h) {
 
 
+/**
+ * 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)
@@ -134,8 +186,16 @@ OTimePickerDialog::OTimePickerDialog ( QWidget* parent, const char* name, WFlags
 }
 
-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 )
 {
@@ -158,4 +218,9 @@ void OTimePickerDialog::setTime( const QTime& time )
 }
 
+/**
+ * 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 )
 {
@@ -167,4 +232,9 @@ void OTimePickerDialog::setHour ( const QString& hour )
 }
 
+/**
+ * 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 )
 {