boolparamwidget.h 2.52 KB
Newer Older
Nicolas Carion's avatar
Nicolas Carion committed
1 2
/***************************************************************************
 *   Copyright (C) 2016 by Nicolas Carion                                  *
Nicolas Carion's avatar
Nicolas Carion committed
3
 *   This file is part of Kdenlive. See www.kdenlive.org.                  *
Nicolas Carion's avatar
Nicolas Carion committed
4 5 6 7
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
Nicolas Carion's avatar
Nicolas Carion committed
8 9 10 11
 *   (at your option) version 3 or any later version accepted by the       *
 *   membership of KDE e.V. (or its successor approved  by the membership  *
 *   of KDE e.V.), which shall act as a proxy defined in Section 14 of     *
 *   version 3 of the license.                                             *
Nicolas Carion's avatar
Nicolas Carion committed
12 13 14 15 16 17 18
 *                                                                         *
 *   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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
Nicolas Carion's avatar
Nicolas Carion committed
19
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
Nicolas Carion's avatar
Nicolas Carion committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
 ***************************************************************************/


#ifndef BOOLPARAMWIDGET_H
#define BOOLPARAMWIDGET_H

#include <QWidget>
#include "ui_boolparamwidget_ui.h"
#include "abstractparamwidget.h"

/** @brief This class represents a parameter that requires
           the user to choose tick a checkbox
 */
class BoolParamWidget : public AbstractParamWidget, public Ui::BoolParamWidget_UI
{
    Q_OBJECT
public:

    /** @brief Constructor for the widgetComment
        @param name String containing the name of the parameter
        @param comment Optional string containing the comment associated to the parameter
        @param checked Boolean indicating wether the checkbox should initially be checked
        @param parent Parent widget
    */
Laurent Montel's avatar
Laurent Montel committed
44
    BoolParamWidget(const QString& name, const QString& comment = QString(), bool checked = false, QWidget *parent = nullptr);
Nicolas Carion's avatar
Nicolas Carion committed
45 46 47 48 49 50 51 52


    /** @brief Returns the current value of the parameter
     */
    bool getValue();

public slots:
    /** @brief Toggle the comments on or off    */
Laurent Montel's avatar
Laurent Montel committed
53
    void slotShowComment(bool) Q_DECL_OVERRIDE;
Nicolas Carion's avatar
Nicolas Carion committed
54 55 56 57
};


#endif