fix filename self-references
[vlc.git] / modules / gui / qt4 / util / customwidgets.hpp
1 /*****************************************************************************
2  * customwidgets.hpp: Custom widgets
3  ****************************************************************************
4  * Copyright (C) 2006 the VideoLAN team
5  * Copyright (C) 2004 Daniel Molkentin <molkentin@kde.org>
6  * $Id$
7  *
8  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
9  * The "ClickLineEdit" control is based on code by  Daniel Molkentin
10  * <molkentin@kde.org> for libkdepim
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifndef _CUSTOMWIDGETS_H_
28 #define _CUSTOMWIDGETS_H_
29
30 #include <QLineEdit>
31 #include <QPushButton>
32 #include <QLabel>
33 #include <QStackedWidget>
34 #include <QSpinBox>
35 #include <QList>
36 #include <QTimer>
37 #include <QToolButton>
38
39 class QPixmap;
40
41 class QFramelessButton : public QPushButton
42 {
43     Q_OBJECT
44 public:
45     QFramelessButton( QWidget *parent = NULL );
46     virtual QSize sizeHint() const { return iconSize(); }
47 protected:
48     virtual void paintEvent( QPaintEvent * event );
49 };
50
51 class QToolButtonExt : public QToolButton
52 {
53     Q_OBJECT
54 public:
55     QToolButtonExt( QWidget *parent = 0, int ms = 0 );
56 private:
57     bool longClick;
58 private slots:
59     void releasedSlot();
60 signals:
61     void shortClicked();
62     void longClicked();
63 };
64
65 class QElidingLabel : public QLabel
66 {
67 public:
68     QElidingLabel( const QString &s = QString(),
69                       Qt::TextElideMode mode = Qt::ElideRight,
70                       QWidget * parent = NULL );
71     void setElideMode( Qt::TextElideMode );
72 protected:
73     virtual void paintEvent( QPaintEvent * event );
74 private:
75     Qt::TextElideMode elideMode;
76 };
77
78
79 class QVLCStackedWidget : public QStackedWidget
80 {
81 public:
82     QVLCStackedWidget( QWidget *parent ) : QStackedWidget( parent ) { }
83     QSize minimumSizeHint () const
84     {
85         return currentWidget() ? currentWidget()->minimumSizeHint() : QSize();
86     }
87 };
88
89 class QVLCDebugLevelSpinBox : public QSpinBox
90 {
91     Q_OBJECT
92 public:
93     QVLCDebugLevelSpinBox( QWidget *parent ) : QSpinBox( parent ) { };
94 protected:
95     virtual QString textFromValue( int ) const;
96     /* QVLCDebugLevelSpinBox is read-only */
97     virtual int valueFromText( const QString& ) const { return -1; }
98 };
99
100 class AnimatedIcon : public QLabel
101 {
102     /** An animated pixmap
103      * Use this widget to display an animated icon based on a series of
104      * pixmaps. The pixmaps will be stored in memory and should be kept small.
105      * First, create the widget, add frames and then start playing. Looping
106      * is supported.
107      * Frames #1 to #n are displayed at regular intervals when playing.
108      * Frame #0 is the idle frame, displayed when the icon is not animated.
109      * If not #0 frame has been specified, the last frame will be shown when
110      * idle.
111      **/
112
113     Q_OBJECT
114
115 public:
116     /** Create an empty AnimatedIcon */
117     AnimatedIcon( QWidget *parent );
118     virtual ~AnimatedIcon();
119
120     /** Adds a frame to play in the loop.
121      * @param pixmap The QPixmap to display. Data will be copied internally.
122      * @param index If -1, append the frame. If 0, replace the idle frame.
123      *              Otherwise, insert the frame at the given position.
124      **/
125     void addFrame( const QPixmap &pixmap, int index = -1 );
126
127     /** Play the animation (or restart it)
128      * @param loops Number of times to play the loop. 0 means stop, while -1
129      *              means play forever. When stopped, the frame #0 will be
130      *              displayed until play() is called again.
131      * @param interval Delay between frames, in milliseconds (minimum 20ms)
132      * @note If isPlaying() is true, then restart the animation from frame #1
133      **/
134     void play( int loops = 1, int interval = 200 );
135
136     /** Stop playback. Same as play(0). */
137     inline void stop()
138     {
139         play( 0 );
140     }
141
142     /** Is the animation currently running? */
143     inline bool isPlaying()
144     {
145         return mTimer.isActive();
146     }
147
148 private:
149     QTimer mTimer;
150     QPixmap *mIdleFrame;
151     QList<QPixmap*> mFrames; // Keeps deep copies of all the frames
152     int mCurrentFrame, mRemainingLoops;
153
154 private slots:
155     /** Slot connected to the timeout() signal of our internal timer */
156     void onTimerTick();
157 };
158
159 class SpinningIcon : public AnimatedIcon
160 {
161     /** This spinning icon, to the colors of the VLC cone, will show
162      * that there is some background activity running
163      **/
164
165     Q_OBJECT
166
167 public:
168     SpinningIcon( QWidget *parent, bool noIdleFrame = false );
169 };
170
171 /* VLC Key/Wheel hotkeys interactions */
172
173 class QKeyEvent;
174 class QWheelEvent;
175 class QInputEvent;
176
177 int qtKeyModifiersToVLC( QInputEvent* e );
178 int qtEventToVLCKey( QKeyEvent *e );
179 int qtWheelEventToVLCKey( QWheelEvent *e );
180 QString VLCKeyToString( unsigned val );
181
182 #endif