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

0001 /***************************************************************************
0002     Copyright (C) 2003-2009 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_STRINGMAPDIALOG_H
0026 #define TELLICO_STRINGMAPDIALOG_H
0027 
0028 #include <QDialog>
0029 
0030 namespace Tellico {
0031   namespace GUI {
0032     class StringMapWidget;
0033   }
0034 
0035 /**
0036  * @short A simple dialog for editing a map between two strings.
0037  *
0038  * A \ref QTreeWidget is used with the map keys in the first column and
0039  * the map values in the second. Two edit boxes are below the list view.
0040  * When an item is selected, the key-value is pair is placed in the edit
0041  * boxes. Add and Delete buttons are used to add a new pair, or to remove
0042  * an existing one.
0043  *
0044  * @author Robby Stephenson
0045  */
0046 class StringMapDialog : public QDialog {
0047 Q_OBJECT
0048 
0049 public:
0050   StringMapDialog(const QMap<QString, QString>& stringMap, QWidget* parent, bool modal=false);
0051 
0052   /**
0053    * Sets the titles for the key and value columns.
0054    *
0055    * @param label1 The name of the key string
0056    * @param label2 The name of the value string
0057    */
0058   void setLabels(const QString& label1, const QString& label2);
0059   /**
0060    * Returns the modified string map.
0061    *
0062    * @return The modified string map
0063    */
0064   QMap<QString, QString> stringMap();
0065 
0066 protected:
0067   GUI::StringMapWidget* m_widget;
0068 };
0069 
0070 } // end namespace
0071 #endif