File indexing completed on 2024-05-12 05:09:49

0001 /***************************************************************************
0002     Copyright (C) 2015 Robby Stephenson <robby@periapsis.org>
0003  ***************************************************************************/
0004 
0005 /***************************************************************************
0006  *                                                                         *
0007  *   This program is free software; you can redistribute it and/or         *
0008  *   modify it under the terms of the GNU General Public License as        *
0009  *   published by the Free Software Foundation; either version 2 of        *
0010  *   the License or (at your option) version 3 or any later version        *
0011  *   accepted by the membership of KDE e.V. (or its successor approved     *
0012  *   by the membership of KDE e.V.), which shall act as a proxy            *
0013  *   defined in Section 14 of version 3 of the license.                    *
0014  *                                                                         *
0015  *   This program is distributed in the hope that it will be useful,       *
0016  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0017  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0018  *   GNU General Public License for more details.                          *
0019  *                                                                         *
0020  *   You should have received a copy of the GNU General Public License     *
0021  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
0022  *                                                                         *
0023  ***************************************************************************/
0024 
0025 #ifndef TELLICO_STRINGMAPWIDGET_H
0026 #define TELLICO_STRINGMAPWIDGET_H
0027 
0028 #include <QWidget>
0029 
0030 class QLineEdit;
0031 class QTreeWidget;
0032 class QTreeWidgetItem;
0033 template <typename T1, typename T2>
0034 class QMap;
0035 
0036 namespace Tellico {
0037   namespace GUI {
0038 
0039 /**
0040  * @short A simple widget for editing a map between two strings.
0041  *
0042  * A \ref QTreeWidget is used with the map keys in the first column and
0043  * the map values in the second. Two edit boxes are below the list view.
0044  * When an item is selected, the key-value is pair is placed in the edit
0045  * boxes. Add and Delete buttons are used to add a new pair, or to remove
0046  * an existing one.
0047  *
0048  * @author Robby Stephenson
0049  */
0050 class StringMapWidget : public QWidget {
0051 Q_OBJECT
0052 
0053 public:
0054   StringMapWidget(const QMap<QString, QString>& stringMap, QWidget* parent);
0055 
0056   /**
0057    * Sets the titles for the key and value columns.
0058    *
0059    * @param label1 The name of the key string
0060    * @param label2 The name of the value string
0061    */
0062   void setLabels(const QString& label1, const QString& label2);
0063   /**
0064    * Returns the modified string map.
0065    *
0066    * @return The modified string map
0067    */
0068   QMap<QString, QString> stringMap();
0069   void setStringMap(const QMap<QString, QString>& stringMap);
0070 
0071 private Q_SLOTS:
0072   void slotAdd();
0073   void slotDelete();
0074   void slotUpdate(QTreeWidgetItem* item);
0075 
0076 protected:
0077   QTreeWidget* m_treeWidget;
0078   QLineEdit* m_edit1;
0079   QLineEdit* m_edit2;
0080 };
0081 
0082   }
0083 } // end namespace
0084 #endif