summaryrefslogtreecommitdiff
path: root/libopie/oticker.h
Unidiff
Diffstat (limited to 'libopie/oticker.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/oticker.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libopie/oticker.h b/libopie/oticker.h
index 30b7517..c848654 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -1,146 +1,147 @@
1/* 1/*
2                This file is part of the Opie Project 2                This file is part of the Opie Project
3 Copyright (c) 2002 L. Potter <ljp@llornkcor.com> 3 Copyright (c) 2002 L. Potter <ljp@llornkcor.com>
4 =. 4 =.
5 .=l. 5 .=l.
6           .>+-= 6           .>+-=
7 _;:,     .>    :=|. This program is free software; you can 7 _;:,     .>    :=|. This program is free software; you can
8.> <`_,   >  .   <= redistribute it and/or modify it under 8.> <`_,   >  .   <= redistribute it and/or modify it under
9:`=1 )Y*s>-.--   : the terms of the GNU General Public 9:`=1 )Y*s>-.--   : the terms of the GNU General Public
10.="- .-=="i,     .._ License as published by the Free Software 10.="- .-=="i,     .._ License as published by the Free Software
11 - .   .-<_>     .<> Foundation; either version 2 of the License, 11 - .   .-<_>     .<> Foundation; either version 2 of the License,
12     ._= =}       : or (at your option) any later version. 12     ._= =}       : or (at your option) any later version.
13    .%`+i>       _;_. 13    .%`+i>       _;_.
14    .i_,=:_.      -<s. This program is distributed in the hope that 14    .i_,=:_.      -<s. This program is distributed in the hope that
15     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY; 15     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
16    : ..    .:,     . . . without even the implied warranty of 16    : ..    .:,     . . . without even the implied warranty of
17    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A 17    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
18  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU 18  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
19..}^=.=       =       ; Library General Public License for more 19..}^=.=       =       ; Library General Public License for more
20++=   -.     .`     .: details. 20++=   -.     .`     .: details.
21 :     =  ...= . :.=- 21 :     =  ...= . :.=-
22 -.   .:....=;==+<; You should have received a copy of the GNU 22 -.   .:....=;==+<; You should have received a copy of the GNU
23  -_. . .   )=.  = Library General Public License along with 23  -_. . .   )=.  = Library General Public License along with
24    --        :-=` this library; see the file COPYING.LIB. 24    --        :-=` this library; see the file COPYING.LIB.
25 If not, write to the Free Software Foundation, 25 If not, write to the Free Software Foundation,
26 Inc., 59 Temple Place - Suite 330, 26 Inc., 59 Temple Place - Suite 330,
27 Boston, MA 02111-1307, USA. 27 Boston, MA 02111-1307, USA.
28 28
29*/ 29*/
30 30
31#ifndef OTICKER_H 31#ifndef OTICKER_H
32#define OTICKER_H 32#define OTICKER_H
33 33
34#include <qwidget.h> 34#include <qwidget.h>
35#include <qpainter.h> 35#include <qpainter.h>
36#include <qdrawutil.h> 36#include <qdrawutil.h>
37#include <qpixmap.h> 37#include <qpixmap.h>
38#include <qstring.h> 38#include <qstring.h>
39#include <qslider.h> 39#include <qslider.h>
40#include <qlabel.h> 40#include <qlabel.h>
41#include <qframe.h> 41#include <qframe.h>
42#include <qcolor.h> 42#include <qcolor.h>
43 43
44/** 44/**
45 * @class OTicker 45 * @class OTicker
46 * @brief The OTicker class provides a QLabel widget that scroll its contents 46 * @brief The OTicker class provides a QLabel widget that scroll its contents
47 * 47 *
48 */ 48 */
49class OTicker : public QLabel { 49class OTicker : public QLabel {
50 Q_OBJECT 50 Q_OBJECT
51 51
52public: 52public:
53 53
54/*! 54/*!
55 * @fn OTicker( QWidget* parent = 0 ) 55 * @fn OTicker( QWidget* parent = 0 )
56 * @brief Object constructor. 56 * @brief Object constructor.
57 * 57 *
58 * @param parent Pointer to parent of this control. 58 * @param parent Pointer to parent of this control.
59 59
60 * Constructs a new OTicker control with parent 60 * Constructs a new OTicker control with parent
61 */ 61 */
62 OTicker( QWidget* parent=0 ); 62 OTicker( QWidget* parent=0 );
63/*! 63/*!
64 * @fn ~OTicker() 64 * @fn ~OTicker()
65 * @brief Object destructor. 65 * @brief Object destructor.
66 */ 66 */
67 ~OTicker(); 67 ~OTicker();
68/*! 68/*!
69 * @fn setText() 69 * @fn setText(const QString& )
70 * @brief sets text to be displayed 70 * @brief sets text to be displayed
71 * @param text QString text to be displayed. 71 * @param text QString text to be displayed.
72 * 72 *
73 */ 73 */
74 void setText( const QString& text ) ; 74 void setText( const QString& text ) ;
75/*! 75/*!
76 * @fn setBackgroundColor(QColor color) 76 * @fn setBackgroundColor(QColor color)
77 * @brief sets color of the ticker's background 77 * @brief sets color of the ticker's background
78 * @param color QColor color to be set. 78 * @param color QColor color to be set.
79 * 79 *
80 */ 80 */
81 //FIXME const QColor& please -zecke
81 void setBackgroundColor(QColor color); 82 void setBackgroundColor(QColor color);
82/*! 83/*!
83 * @fn setForegroundColor(QColor color) 84 * @fn setForegroundColor(QColor color)
84 * @brief sets color of text 85 * @brief sets color of text
85 * @param color QColor color of text 86 * @param color QColor color of text
86 * 87 *
87 */ 88 */
88 void setForegroundColor(QColor color); 89 void setForegroundColor(QColor color);
89/*! 90/*!
90 * @fn setFrame(int style) 91 * @fn setFrame(int style)
91 * @brief sets frame style 92 * @brief sets frame style
92 * @param style int Frame style to be see. See Qt::WidgetFlags. 93 * @param style int Frame style to be see. See Qt::WidgetFlags.
93 * 94 *
94 */ 95 */
95 void setFrame(int style); 96 void setFrame(int style);
96/*! 97/*!
97 * @fn setUpdateTime(int timeout) 98 * @fn setUpdateTime(int timeout)
98 * @brief sets time of update 99 * @brief sets time of update
99 * @param timeout int time in milliseconds between updates. 100 * @param timeout int time in milliseconds between updates.
100 * 101 *
101 */ 102 */
102 void setUpdateTime(int timeout); 103 void setUpdateTime(int timeout);
103/*! 104/*!
104 * @fn setScrollLength(int length) 105 * @fn setScrollLength(int length)
105 * @brief sets amount of scrolling default is 1 106 * @brief sets amount of scrolling default is 1
106 * @param length int scroll length. 107 * @param length int scroll length.
107 * 108 *
108 */ 109 */
109 void setScrollLength(int length); 110 void setScrollLength(int length);
110signals: 111signals:
111/*! 112/*!
112 * @fn mousePressed() 113 * @fn mousePressed()
113 * @brief signal mouse press event 114 * @brief signal mouse press event
114 * 115 *
115 */ 116 */
116 void mousePressed(); 117 void mousePressed();
117protected: 118protected:
118/*! 119/*!
119 * @fn timerEvent( QTimerEvent * e) 120 * @fn timerEvent( QTimerEvent * e)
120 * @brief timer timeout event 121 * @brief timer timeout event
121 * @param e QEvent see QEvent. 122 * @param e QEvent see QEvent.
122 * 123 *
123 */ 124 */
124 void timerEvent( QTimerEvent * e); 125 void timerEvent( QTimerEvent * e);
125/*! 126/*!
126 * @fn drawContents( QPainter *p ) 127 * @fn drawContents( QPainter *p )
127 * @brief draws widget contents 128 * @brief draws widget contents
128 * @param p QPainter. see QPainter 129 * @param p QPainter. see QPainter
129 * 130 *
130 */ 131 */
131 void drawContents( QPainter *p ); 132 void drawContents( QPainter *p );
132/*! 133/*!
133 * @fn mouseReleaseEvent( QMouseEvent *e) 134 * @fn mouseReleaseEvent( QMouseEvent *e)
134 * @brief mouse release event 135 * @brief mouse release event
135 * @param e QMouseEvent. see QMouseEvent. 136 * @param e QMouseEvent. see QMouseEvent.
136 * 137 *
137 */ 138 */
138 void mouseReleaseEvent( QMouseEvent *e); 139 void mouseReleaseEvent( QMouseEvent *e);
139private: 140private:
140 QColor backgroundcolor, foregroundcolor; 141 QColor backgroundcolor, foregroundcolor;
141 QString scrollText; 142 QString scrollText;
142 QPixmap scrollTextPixmap; 143 QPixmap scrollTextPixmap;
143 int pos, updateTimerTime, scrollLength; 144 int pos, updateTimerTime, scrollLength;
144}; 145};
145 146
146#endif 147#endif