summaryrefslogtreecommitdiff
path: root/libopie/oticker.h
blob: 30b75176a7f7d2dd3bb81559aea8cb7982b7bc3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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 <qcolor.h>

/**
 * @class OTicker
 * @brief The OTicker class provides a QLabel widget that scroll its contents
 *
 */
class OTicker : public QLabel {
    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 ) ;
/*!
 * @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:
/*!
 * @fn mousePressed()
 * @brief signal mouse press event
 *
 */
    void mousePressed();
protected:
/*!
 * @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 );
/*!
 * @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