OpenMS
BaseVisualizerGUI.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2023.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer:Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
40 #include <OpenMS/CONCEPT/Types.h>
41 
42 #include <QtWidgets>
43 
44 class QPushButton;
45 class QGridLayout;
46 class QLineEdit;
47 class QTextEdit;
48 class QComboBox;
49 class QListWidget;
50 class QLabel;
51 
52 namespace OpenMS
53 {
64  class OPENMS_GUI_DLLAPI BaseVisualizerGUI :
65  public QWidget
66  {
67  Q_OBJECT
68 
69 public:
70 
72  BaseVisualizerGUI(bool editable = false, QWidget * parent = nullptr);
73 
75  bool isEditable() const;
76 
77 signals:
78 
80  void sendStatus(std::string status);
81 
82 public slots:
83 
85  virtual void store() = 0;
86 
87 protected:
88 
90  void addLabel_(const QString& label);
92  void addLabel_(const QString& label, UInt row);
94  void addLineEdit_(QLineEdit * & ptr, QString label);
96  void addIntLineEdit_(QLineEdit * & ptr, QString label);
98  void addDoubleLineEdit_(QLineEdit * & ptr, QString label);
100  void addLineEditButton_(const QString& label, QLineEdit * & ptr1, QPushButton * & ptr2, const QString& buttonlabel);
102  void addListView_(QListWidget * & ptr, QString label);
104  void addTextEdit_(QTextEdit * & ptr, QString label);
106  void addComboBox_(QComboBox * & ptr, QString label);
108  void addBooleanComboBox_(QComboBox * & ptr, QString label);
110  void fillComboBox_(QComboBox * & ptr, const std::string * items, int item_count);
112  void addVSpacer_();
114  void addButton_(QPushButton * & ptr, const QString& label);
116  void add2Buttons_(QPushButton * & ptr1, const QString& label1, QPushButton * & ptr2, const QString& label2);
121 
123  QPushButton * undo_button_;
125  QGridLayout * mainlayout_;
129  bool editable_;
130  };
131 
132 
133 }
A base class for all visualizer classes.
Definition: BaseVisualizerGUI.h:66
bool isEditable() const
Returns if the values are editable.
void finishAdding_()
Adds buttons common to all visualizers.
void addComboBox_(QComboBox *&ptr, QString label)
Adds a drop-down field to the grid layout.
void addTextEdit_(QTextEdit *&ptr, QString label)
Adds a text edit field to the grid layout.
void add2Buttons_(QPushButton *&ptr1, const QString &label1, QPushButton *&ptr2, const QString &label2)
Adds two buttons in a row.
QPushButton * undo_button_
Undo button.
Definition: BaseVisualizerGUI.h:123
void addVSpacer_()
Adds vertical spacer.
void sendStatus(std::string status)
Sends a status message, if date is not in proper format.
void addListView_(QListWidget *&ptr, QString label)
Adds a list edit field to the grid layout.
BaseVisualizerGUI(bool editable=false, QWidget *parent=nullptr)
Constructor.
void addSeparator_()
Adds a horizontal line as a separator.
virtual void store()=0
Saves the changes made in the GUI to the object.
void addIntLineEdit_(QLineEdit *&ptr, QString label)
Adds a line edit field to the grid layout including a int validator.
void fillComboBox_(QComboBox *&ptr, const std::string *items, int item_count)
Fills a combo box with string items (the number of strings is determined by item_count).
void addLineEditButton_(const QString &label, QLineEdit *&ptr1, QPushButton *&ptr2, const QString &buttonlabel)
Adds a line edit field with label and button to the next free position in the grid.
void addLabel_(const QString &label, UInt row)
Adds a label to a certain row.
bool editable_
Edit flag.
Definition: BaseVisualizerGUI.h:129
UInt row_
Counter for the current grid row.
Definition: BaseVisualizerGUI.h:127
void addDoubleLineEdit_(QLineEdit *&ptr, QString label)
Adds a line edit field to the grid layout including a double validator.
void addLineEdit_(QLineEdit *&ptr, QString label)
Adds a line edit field with label to the grid layout.
void addButton_(QPushButton *&ptr, const QString &label)
Adds a button to the next free position in the grid.
QGridLayout * mainlayout_
The main layout.
Definition: BaseVisualizerGUI.h:125
void addBooleanComboBox_(QComboBox *&ptr, QString label)
Adds a boolean drop-down field to the grid layout ( 'true'=1, 'false'=0 ).
void addLabel_(const QString &label)
Adds a label to the grid layout.
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48