summaryrefslogtreecommitdiff
authorllornkcor <llornkcor>2003-03-21 19:45:10 (UTC)
committer llornkcor <llornkcor>2003-03-21 19:45:10 (UTC)
commit9610419c1fe5f91f257cefa8b8753872da87445f (patch) (side-by-side diff)
treeeec1902cc5c77ebdf3eb9c88c57ca6e4ba1710ce
parentd3f71dadbd2dafcf42480afeffe75e7e36ec7d9c (diff)
downloadopie-9610419c1fe5f91f257cefa8b8753872da87445f.zip
opie-9610419c1fe5f91f257cefa8b8753872da87445f.tar.gz
opie-9610419c1fe5f91f257cefa8b8753872da87445f.tar.bz2
added doxygen comment docs
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--libopie/oticker.h95
1 files changed, 85 insertions, 10 deletions
diff --git a/libopie/oticker.h b/libopie/oticker.h
index b7499e3..5df08da 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -1,71 +1,146 @@
/*
                This file is part of the Opie Project
Copyright (c) 2002 L. Potter <ljp@llornkcor.com>
=.
.=l.
           .>+-=
 _;:,     .>    :=|. This program is free software; you can
.> <`_,   >  .   <= redistribute it and/or modify it under
:`=1 )Y*s>-.--   : the terms of the GNU General Public
.="- .-=="i,     .._ License as published by the Free Software
 - .   .-<_>     .<> Foundation; either version 2 of the License,
     ._= =}       : or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s. This program is distributed in the hope that
     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
    : ..    .:,     . . . without even the implied warranty of
    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
..}^=.=       =       ; Library General Public License for more
++=   -.     .`     .: details.
 :     =  ...= . :.=-
 -.   .:....=;==+<; You should have received a copy of the GNU
  -_. . .   )=.  = Library General Public License along with
    --        :-=` this library; see the file COPYING.LIB.
If not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef OTICKER_H
#define OTICKER_H
#include <qwidget.h>
#include <qpainter.h>
#include <qdrawutil.h>
#include <qpixmap.h>
#include <qstring.h>
#include <qslider.h>
#include <qlabel.h>
#include <qframe.h>
-#include <qlineedit.h>
#include <qcolor.h>
-
+/*!
+ * @class OTicker
+ * @brief The OTicker class provides a QLabel widget that scroll its contents
+ *
+*/
class OTicker : public QLabel {
//class OTicker : public QFrame {
Q_OBJECT
public:
+
+/*!
+ * @fn OTicker( QWidget* parent = 0 )
+ * @brief Object constructor.
+ *
+ * @param parent Pointer to parent of this control.
+
+ * Constructs a new OTicker control with parent
+ */
OTicker( QWidget* parent=0 );
+/*!
+ * @fn ~OTicker()
+ * @brief Object destructor.
+ */
~OTicker();
+/*!
+ * @fn setText()
+ * @brief sets text to be displayed
+ * @param text QString text to be displayed.
+ *
+ */
void setText( const QString& text ) ;
- void setBackgroundColor(QColor color); //sets background
- void setForegroundColor(QColor color); //sets text color
- void setFrame(int); //sets frame style
- void setUpdateTime(int); //sets timeout for redraws default is 50 ms
- void setScrollLength(int); //sets amount of scrolling default is 1
+/*!
+ * @fn setBackgroundColor(QColor color)
+ * @brief sets color of the ticker's background
+ * @param color QColor color to be set.
+ *
+ */
+ void setBackgroundColor(QColor color);
+/*!
+ * @fn setForegroundColor(QColor color)
+ * @brief sets color of text
+ * @param color QColor color of text
+ *
+ */
+ void setForegroundColor(QColor color);
+/*!
+ * @fn setFrame(int style)
+ * @brief sets frame style
+ * @param style int Frame style to be see. See Qt::WidgetFlags.
+ *
+ */
+ void setFrame(int style);
+/*!
+ * @fn setUpdateTime(int timeout)
+ * @brief sets time of update
+ * @param timeout int time in milliseconds between updates.
+ *
+ */
+ void setUpdateTime(int timeout);
+/*!
+ * @fn setScrollLength(int length)
+ * @brief sets amount of scrolling default is 1
+ * @param length int scroll length.
+ *
+ */
+ void setScrollLength(int length);
signals:
- void mousePressed(); // for mouse press events
+/*!
+ * @fn mousePressed()
+ * @brief signal mouse press event
+ *
+ */
+ void mousePressed();
protected:
- void timerEvent( QTimerEvent * );
+/*!
+ * @fn timerEvent( QTimerEvent * e)
+ * @brief timer timeout event
+ * @param e QEvent see QEvent.
+ *
+ */
+ void timerEvent( QTimerEvent * e);
+/*!
+ * @fn drawContents( QPainter *p )
+ * @brief draws widget contents
+ * @param p QPainter. see QPainter
+ *
+ */
void drawContents( QPainter *p );
- void mouseReleaseEvent ( QMouseEvent *);
+/*!
+ * @fn mouseReleaseEvent( QMouseEvent *e)
+ * @brief mouse release event
+ * @param e QMouseEvent. see QMouseEvent.
+ *
+ */
+ void mouseReleaseEvent( QMouseEvent *e);
private:
QColor backgroundcolor, foregroundcolor;
QString scrollText;
QPixmap scrollTextPixmap;
int pos, updateTimerTime, scrollLength;
};
#endif