git.sesse.net Git - kdenlive/blob - src/doubleparameterwidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Till Theato (root@ttill.de)                     *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program 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         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  18  ***************************************************************************/
  19
  20
  21 #ifndef DOUBLEPARAMETERWIDGET_H
  22 #define DOUBLEPARAMETERWIDGET_H
  23
  24 #include <QWidget>
  25
  26 class QLabel;
  27 class QSlider;
  28 class QSpinBox;
  29
  30 /**
  31  * @class DoubleParameterWidget
  32  * @brief Widget to choose a double parameter (for a effect) with the help of a slider and a spinbox.
  33  * @author Till Theato
  34  *
  35  * The widget does only handle integers, so the parameter has to be converted into the proper double range afterwards.
  36  */
  37
  38 class DoubleParameterWidget : public QWidget
  39 {
  40     Q_OBJECT
  41 public:
  42     /** @brief Sets up the parameter's GUI.
  43     * @param name Name of the parameter
  44     * @param value Value of the parameter
  45     * @param min Minimum value
  46     * @param max maximum value
  47     * @param defaultValue Value used when using reset functionality
  48     * @param comment A comment explaining the parameter. Will be shown for the tooltip.
  49     * @param suffix (optional) Suffix to display in spinbox
  50     * @param parent (optional) Parent Widget */
  51     DoubleParameterWidget(const QString &name, int value, int min, int max, int defaultValue, const QString &comment, const QString suffix = QString(), QWidget* parent = 0);
  52
  53     /** @brief Updates the label to display @param name. */
  54     void setName(const QString &name);
  55
  56     /** @brief Gets the parameter's value. */
  57     int getValue();
  58
  59 public slots:
  60     /** @brief Sets the value to @param value. */
  61     void setValue(int value);
  62
  63     /** @brief Sets value to m_default. */
  64     void slotReset();
  65
  66 private slots:
  67     /** @brief Shows/Hides the comment label. */
  68     void slotShowComment(bool show);
  69
  70 private:
  71     int m_default;
  72     QLabel *m_name;
  73     QSlider *m_slider;
  74     QSpinBox *m_spinBox;
  75     QLabel *m_commentLabel;
  76
  77 signals:
  78     void valueChanged(int);
  79 };
  80
  81 #endif