ListEditor.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: David Wojnar $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#ifndef Q_MOC_RUN
  #include <OpenMS/DATASTRUCTURES/ListUtils.h>
#endif
 
#include <QDialog>
#include <QListWidget>
#include <QItemDelegate>
 
class QPushButton;
 
namespace OpenMS
{
  namespace Internal
  {
    class ListTable;
    class ListEditorDelegate;
  }
 
  class OPENMS_GUI_DLLAPI ListEditor :
    public QDialog
  {
    Q_OBJECT
 
public:
    //types of lists
    enum Type
    {
      INT,
      FLOAT,
      STRING,
      OUTPUT_FILE,
      INPUT_FILE
    };
 
    ListEditor(QWidget * parent = nullptr, const QString& title = "");
    StringList getList() const;
    void setList(const StringList & list, ListEditor::Type type);
    void setListRestrictions(const String & restrictions);
    void setTypeName(QString name);
 
private:
    ListEditor::Type type_;
    Internal::ListTable * listTable_;
    Internal::ListEditorDelegate * listDelegate_;
    QPushButton * newRowButton_;
    QPushButton * removeRowButton_;
    QPushButton * OkButton_;
    QPushButton * CancelButton_;
  };
 
  namespace Internal
  {
    class OPENMS_GUI_DLLAPI ListTable :
      public QListWidget
    {
      Q_OBJECT
 
public:
 
      //Default Constructor
      ListTable(QWidget * parent = nullptr);
 
      //returns a list_
      StringList getList();
 
      //sets new list
      void setList(const StringList & list, ListEditor::Type type);
 
public slots:
      void createNewRow();
      void removeCurrentRow();
 
private:
      ListEditor::Type type_;
      //everything is internally stored as stringlist
      StringList list_;
    };
 
    class OPENMS_GUI_DLLAPI ListEditorDelegate :
      public QItemDelegate
    {
      Q_OBJECT
 
public:
      ListEditorDelegate(QObject * parent);
      QWidget * createEditor(QWidget * parent, const QStyleOptionViewItem & option, const QModelIndex & index) const override;
      void setEditorData(QWidget * editor, const QModelIndex & index) const override;
      void setModelData(QWidget * editor, QAbstractItemModel * model, const QModelIndex & index) const override;
      void updateEditorGeometry(QWidget * editor, const QStyleOptionViewItem & option, const QModelIndex & index) const override;
 
      //sets Type of List
      void setType(const ListEditor::Type type);
      //sets restrictions for listelements
      void setRestrictions(const String & restrictions);
      void setTypeName(QString name);
      void setFileName(QString name);
 
private:
      ListEditorDelegate();
      ListEditor::Type type_;
      String restrictions_;
      QString typeName_;
      mutable QString file_name_;
 
    };
  }
 
} // namespace OpenMS