parameter_delegate.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2010 - 2013 by Martin Steigemann and Wolfgang Bangerth
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------


#ifndef PARAMETERDELEGATE_H
#define PARAMETERDELEGATE_H

#include <QItemDelegate>
#include <QModelIndex>
#include <QObject>
#include <QLineEdit>
#include <QComboBox>
#include <QFileDialog>

#include "browse_lineedit.h"


namespace dealii
{
  /*! @addtogroup ParameterGui
   *@{
   */
  namespace ParameterGui
  {
    /**
     * The ParameterDelegate class implements special delegates for the QTreeWidget class used in the parameterGUI.
     * The QTreeWidget class provides some different standard delegates for editing parameters shown in the
     * tree structure. The ParameterDelegate class provides special editors for the different types of parameters defined in
     * the ParameterHandler class. For all parameter types based on strings as &quot;Anything&quot;, &quot;MultipleSelection&quot; &quot;Map&quot; and
     * &quot;List&quot; a simple line editor will be shown up. In the case of integer and double type parameters the editor is a spin box and for
     * &quot;Selection&quot; type parameters a combo box will be shown up. For parameters of type &quot;FileName&quot; and &quot;DirectoryName&quot;
     * the delegate shows a @ref BrowseLineEdit editor. The column of the tree structure with the parameter values has to be set
     * in the constructor.
     *
     * @note This class is used in the graphical user interface for the @ref ParameterHandler class.
     *       It is not compiled into the deal.II libraries and can not be used by applications using deal.II.
     *
     * @ingroup ParameterGui
     * @author Martin Steigemann, Wolfgang Bangerth, 2010
     */
    class ParameterDelegate : public QItemDelegate
    {
      Q_OBJECT

    public:
      /**
       * Constructor, @p value_column specifies the column
       * of the parameter tree this delegate will be used on.
       */
      ParameterDelegate (const int value_column, QObject *parent = 0);

      /**
       * This function creates the appropriate editor for the parameter
       * based on the <tt>index</tt>.
       */
      QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &option,
                            const QModelIndex &index) const;

      /**
       * Reimplemented from QItemDelegate.
       */
      QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const;

      /**
       * Reimplemented from QItemDelegate.
       */
      void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const;

      /**
       * Reimplemented from QItemDelegate.
       */
      void setEditorData(QWidget *editor, const QModelIndex &index) const;

      /**
       * Reimplemented from QItemDelegate.
       */
      void setModelData(QWidget *editor, QAbstractItemModel *model,
                        const QModelIndex &index) const;

    private slots:
      /**
       * Reimplemented from QItemDelegate.
       */
      void commit_and_close_editor();

    private:
      /**
       * The column this delegate will be used on.
       */
      int value_column;
    };
  }
  /**@}*/
}


#endif