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, 31 insertions, 2 deletions

diff --git a/libopie/oclickablelabel.cpp b/libopie/oclickablelabel.cpp
index 5768529..bc7037b 100644
--- a/libopie/oclickablelabel.cpp
+++ b/libopie/oclickablelabel.cpp
@@ -1,88 +1,117 @@
 #include "oclickablelabel.h"
 #include <stdio.h>
 
-OClickableLabel::OClickableLabel(QWidget* parent, 
-                               const char* name, 
+/**
+ * This constructs the clickable ButtonLabel
+ *
+ * @param parent The parent of this label
+ * @param name A name of this label @see QObject
+ * @param fl The windowing flags
+ */
+OClickableLabel::OClickableLabel(QWidget* parent,
+                               const char* name,
                                WFlags fl) :
   QLabel(parent,name,fl)
 {
     textInverted=false;
     isToggle=false;
     isDown=false;
     showState(false);
     setFrameShadow(Sunken);
 }
 
+/**
+ * This method makes the label behave as a toggle button
+ *
+ * @param t Whether or not to behave like a toggle button
+ */
 void OClickableLabel::setToggleButton(bool t) {
     isToggle=t;
 }
 
+/**
+ * @internal
+ */
 void OClickableLabel::mousePressEvent( QMouseEvent * /*e*/ ) {
     if (isToggle && isDown) {
         showState(false);
     } else {
         showState(true);
     }
 }
 
+/**
+ * @internal
+ */
 void OClickableLabel::mouseReleaseEvent( QMouseEvent *e ) {
     if (rect().contains(e->pos()) && isToggle) isDown=!isDown;
 
     if (isToggle && isDown) {
         showState(true);
     } else {
         showState(false);
     }
 
     if (rect().contains(e->pos())) {
         if (isToggle) {
             emit toggled(isDown);
         }
         emit clicked();
     }
 }
 
+/**
+ * @internal
+ */
 void OClickableLabel::mouseMoveEvent( QMouseEvent *e ) {
     if (rect().contains(e->pos())) {
         if (isToggle && isDown) {
             showState(false);
         } else {
             showState(true);
         }
     } else {
         if (isToggle && isDown) {
             showState(true);
         } else {
             showState(false);
         }
     }
 }
 
+/**
+ * this toggles the label and inverts the color of
+ * the label
+ * @param on
+ */
 void OClickableLabel::showState(bool on) {
   if (on) {
     //setFrameShape(Panel);
     setInverted(true);
     setBackgroundMode(PaletteHighlight);
   } else {
     //setFrameShape(NoFrame);
     setInverted(false);
     setBackgroundMode(PaletteBackground);
   }
   repaint();
 }
 
 void OClickableLabel::setInverted(bool on) {
     if ( (!textInverted && on) || (textInverted && !on) ) {
         QPalette pal=palette();
         QColor col=pal.color(QPalette::Normal, QColorGroup::Foreground);
         col.setRgb(255-col.red(),255-col.green(),255-col.blue());
         pal.setColor(QPalette::Normal, QColorGroup::Foreground, col);
         setPalette(pal);
         textInverted=!textInverted;
     }
 }
 
+/**
+ * @param on if the Label is down or up
+ */
 void OClickableLabel::setOn(bool on) {
   isDown=on;
   showState(isDown);
 }