listparamwidget.h 3.41 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 LISTPARAMETERWIDGET_H
#define LISTPARAMETERWIDGET_H

#include <QWidget>
#include <QVariant>
#include "ui_listparamwidget_ui.h"
#include "abstractparamwidget.h"

/** @brief This class represents a parameter that requires
           the user to choose a value from a list
 */
class ListParamWidget : public AbstractParamWidget, public Ui::ListParamWidget_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 parent Parent widget
    */
Laurent Montel's avatar
Laurent Montel committed
44
    ListParamWidget(const QString& name, const QString& comment = QString(), QWidget *parent = nullptr);
Nicolas Carion's avatar
Nicolas Carion committed
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

    /** @brief Set the index of the current displayed element
        @param index Integer holding the index of the target element (0-indexed)
    */
    void setCurrentIndex(int index);

    /** @brief Set the text currently displayed on the list
        @param text String containing the text of the element to show
    */
    void setCurrentText(const QString& text);

    /** @brief Add an item to the list.
        @param text String to be displayed in the list
        @param value Underlying value corresponding to the text
    */
    void addItem(const QString &text, const QVariant &value = QVariant());

    /** @brief Set the icon of a given element
        @param index Integer holding the index of the target element (0-indexed)
        @param icon The corresponding icon
    */
    void setItemIcon(int index, const QIcon &icon);

    /** @brief Set the size of the icons shown in the list
        @param size Target size of the icon
    */
    void setIconSize(const QSize& size);

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

public slots:
    /** @brief Toggle the comments on or off    */
Laurent Montel's avatar
Laurent Montel committed
79
    void slotShowComment(bool) Q_DECL_OVERRIDE;
Nicolas Carion's avatar
Nicolas Carion committed
80 81 82 83
};


#endif