OpenMS
Plot2DGoToDialog.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 #include <OpenMS/VISUAL/PlotCanvas.h> // for AreaXYType
42 
43 #include <QtWidgets/QDialog>
44 
45 namespace Ui
46 {
47  class Plot2DGoToDialogTemplate;
48 }
49 
50 namespace OpenMS
51 {
52 
53  class String;
54 
60  class OPENMS_GUI_DLLAPI Plot2DGoToDialog :
61  public QDialog
62  {
63  Q_OBJECT
64 
65 public:
67 
72  Plot2DGoToDialog(QWidget* parent, std::string_view x_name, std::string_view y_name);
74  ~Plot2DGoToDialog() override;
75 
77  bool showRange() const;
78 
79  bool checked();
80 
82 
83  void setRange(const AreaXYType& range);
86  void setMinMaxOfRange(const AreaXYType& max_range);
87 
92 
94 
95  String getFeatureNumber() const;
98  void enableFeatureNumber(bool);
100 
101  private:
102  Ui::Plot2DGoToDialogTemplate* ui_;
103 
104  };
105 
106 }
GoTo dialog used to zoom to a m/z and retention time range or to a feature.
Definition: Plot2DGoToDialog.h:62
Ui::Plot2DGoToDialogTemplate * ui_
Definition: Plot2DGoToDialog.h:102
~Plot2DGoToDialog() override
Destructor.
Plot2DGoToDialog(QWidget *parent, std::string_view x_name, std::string_view y_name)
void setMinMaxOfRange(const AreaXYType &max_range)
Sets the data range of the complete experiment for better navigation with the dialog.
PlotCanvas::AreaXYType AreaXYType
Definition: Plot2DGoToDialog.h:66
void enableFeatureNumber(bool)
Disables the feature number field.
bool showRange() const
Returns if a feature UID was set an a feature should be displayed (false), otherwise,...
Area< 2 >::AreaXYType AreaXYType
The range of data shown on the X and Y axis (unit depends on runtime config)
Definition: PlotCanvas.h:178
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
Definition: FLASHDeconvWizardBase.h:63