1 /* This file is part of the KDE project
2 Copyright (c) 2010 Jean-Baptiste Mardelle <jb@kdenlive.org>
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version.
9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef TIMECODEDISPLAY_H_
21 #define TIMECODEDISPLAY_H_
23 #include "ui_timecodedisplay_ui.h"
29 * @class TimecodeDisplay
30 * @brief A widget for inserting a timecode value.
31 * @author Jean-Baptiste Mardelle
33 * TimecodeDisplay can be used to insert eigther frames
34 * or a timecode in the format HH:MM:SS:FF
36 class TimecodeDisplay : public QWidget, public Ui::TimecodeDisplay_UI
41 /** @brief Constructor for the widget, sets value to 0.
42 * @param t Timecode object used to setup correct input (frames or HH:MM:SS:FF)
43 * @param parent parent Widget */
44 TimecodeDisplay(Timecode t, QWidget *parent = 0);
46 /** @brief Returns the minimum value, which can be entered.
50 /** @brief Returns the maximum value, which can be entered.
51 * default is no maximum (-1) */
54 /** @brief Sets the minimum maximum value that can be entered.
55 * @param min the minimum value
56 * @param max the maximum value */
57 void setRange(int min, int max);
59 /** @brief Returns the current input in frames. */
62 /** @brief Returns the current input as a GenTime object. */
63 GenTime gentime() const;
65 /** @brief Returs the widget's timecode object. */
66 Timecode timecode() const;
68 /** @brief Sets value's format to frames or HH:MM:SS:FF according to @param frametimecode.
69 * @param frametimecode true = frames, false = HH:MM:SS:FF */
70 void setTimeCodeFormat(bool frametimecode);
73 /** timecode for widget */
75 /** Should we display the timecode in frames or in format hh:mm:ss:ff */
81 /** @brief Sets the value.
82 * @param value the new value
83 * The value actually set is forced to be within the legal range: minimum <= value <= maximum */
84 void setValue(int value);
85 void setValue(const QString &value);
86 void setValue(GenTime value);
88 /** @brief Sets value's format accorrding to Kdenlive's settings.
89 * @param t (optional, if already existing) Timecode object to use */
90 void slotUpdateTimeCodeFormat();
98 * Emitted every time the value changes (by calling setValue() or
99 * by user interaction).
100 * @param value the new value
101 * @param final if the value is final ie not produced during sliding (on slider release it's final)
103 void valueChanged(int value, bool final);
104 void editingFinished();
107 virtual void keyPressEvent(QKeyEvent *e);
108 virtual void wheelEvent(QWheelEvent *e);