tellico/src/gui/stringmapdialog.h

/***************************************************************************
    copyright            : (C) 2003-2006 by Robby Stephenson
    email                : robby@periapsis.org
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of version 2 of the GNU General Public License as  *
 *   published by the Free Software Foundation;                            *
 *                                                                         *
 ***************************************************************************/

#ifndef STRINGMAPDIALOG_H
#define STRINGMAPDIALOG_H

class KLineEdit;
class KListView;
class TQListViewItem;

#include <kdialogbase.h>

template <typename T1, typename T2>
class TQMap;

namespace Tellico {

/**
 * @short A simple dialog for editing a map between two strings.
 *
 * A \ref KListView is used with the map keys in the first column and
 * the map values in the second. Two edit boxes are below the list view.
 * When an item is selected, the key-value is pair is placed in the edit
 * boxes. Add and Delete buttons are used to add a new pair, or to remove
 * an existing one.
 *
 * @author Robby Stephenson
 */
class StringMapDialog : public KDialogBase {
Q_OBJECT
  

public:
  StringMapDialog(const TQMap<TQString, TQString>& stringMap, TQWidget* parent, const char* name=0, bool modal=false);

  /**
   * Sets the titles for the key and value columns.
   *
   * @param label1 The name of the key string
   * @param label2 The name of the value string
   */
  void setLabels(const TQString& label1, const TQString& label2);
  /**
   * Returns the modified string map.
   *
   * @return The modified string map
   */
  TQMap<TQString, TQString> stringMap();

private slots:
  void slotAdd();
  void slotDelete();
  void slotUpdate(TQListViewItem* item);

protected:
  KListView* m_listView;
  KLineEdit* m_edit1;
  KLineEdit* m_edit2;
};

} // end namespace
#endif