OpenMS
Annotations1DContainer.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: Johannes Veit $
32 // $Authors: Johannes Junker $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 #include <list>
40 
41 #include <QtGui/QPen>
42 
43 class QPoint;
44 class QObject;
45 class QRectF;
46 class QPainter;
47 
48 namespace OpenMS
49 {
50  class Annotation1DItem;
51 
54  public std::list<Annotation1DItem *>
55  {
56 public:
59 
62 
65 
68 
69  using Base = std::list<Annotation1DItem *>;
70 
72  using Iterator = Base::iterator;
73 
75  using ConstIterator = std::list<Annotation1DItem *>::const_iterator;
76 
79 
81  using CoordinateType = double;
82 
88  Annotation1DItem * getItemAt(const QPoint & pos) const;
89 
91  void selectItemAt(const QPoint & pos) const;
92 
94  void deselectItemAt(const QPoint & pos) const;
95 
97  void selectAll();
98 
100  void deselectAll();
101 
104 
106  std::vector<Annotation1DItem*> getSelectedItems();
107 
109  void setPen(const QPen & pen);
110 
112  const QPen & getPen() const;
113 
115  void setSelectedPen(const QPen & pen);
116 
118  const QPen & getSelectedPen() const;
119 
120  protected:
122  void deleteAllItems_() const;
123 
125  QPen pen_;
126 
129  };
130 
131 } // namespace
132 
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:62
Container for annotations to content of Plot1DCanvas.
Definition: Annotations1DContainer.h:55
double CoordinateType
Coordinate type.
Definition: Annotations1DContainer.h:81
const QPen & getSelectedPen() const
Returns the selected_pen_.
void deselectAll()
Deselects all items.
void deselectItemAt(const QPoint &pos) const
Deselects the item at pos on the canvas, if it exists.
void deleteAllItems_() const
call delete on all pointers in the container, without modifying the container
void setPen(const QPen &pen)
Sets the pen_.
Annotations1DContainer(const Annotations1DContainer &rhs)
Copy constructor.
void selectItemAt(const QPoint &pos) const
Selects the item at pos on the canvas, if it exists.
std::list< Annotation1DItem * >::const_iterator ConstIterator
Const iterator for the 1D annotations.
Definition: Annotations1DContainer.h:75
QPen pen_
The pen used to draw items.
Definition: Annotations1DContainer.h:125
QPen selected_pen_
The pen used to draw selected items.
Definition: Annotations1DContainer.h:128
void setSelectedPen(const QPen &pen)
Sets the selected_pen_.
const QPen & getPen() const
Returns the pen_.
void removeSelectedItems()
Removes the selected items.
std::vector< Annotation1DItem * > getSelectedItems()
Returns the selected items.
void selectAll()
Selects all items.
Annotations1DContainer & operator=(const Annotations1DContainer &rhs)
Assignment operator.
Annotations1DContainer()
Default constructor.
virtual ~Annotations1DContainer()
Destructor.
std::list< Annotation1DItem * > Base
Definition: Annotations1DContainer.h:69
Annotation1DItem * getItemAt(const QPoint &pos) const
Returns a pointer to the item at pos, or 0, if not existent.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48