| OpenMS 2.5.0

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-2020.
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
37 #include <OpenMS/DATASTRUCTURES/DPosition.h>
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
53 class Annotations1DContainer :
54 public std::list<Annotation1DItem *>
55 {
56 public:
58 Annotations1DContainer();
59
61 Annotations1DContainer(const Annotations1DContainer & rhs);
62
64 Annotations1DContainer & operator=(const Annotations1DContainer & rhs);
65
67 virtual ~Annotations1DContainer();
68
70 typedef std::list<Annotation1DItem *>::iterator Iterator;
71
73 typedef std::list<Annotation1DItem *>::const_iterator ConstIterator;
74
76 typedef DPosition<2> PointType;
77
79 typedef double CoordinateType;
80
86 Annotation1DItem * getItemAt(const QPoint & pos) const;
87
89 void selectItemAt(const QPoint & pos);
90
92 void deselectItemAt(const QPoint & pos);
93
95 void selectAll();
96
98 void deselectAll();
99
101 void removeSelectedItems();
102
104 std::vector<Annotation1DItem*> getSelectedItems();
105
107 void setPen(const QPen & pen);
108
110 const QPen & getPen() const;
111
113 void setSelectedPen(const QPen & pen);
114
116 const QPen & getSelectedPen() const;
117
119 QPen pen_;
120
122 QPen selected_pen_;
123 };
124
125 } // namespace
126
OpenMS::Annotations1DContainer::selectAll
void selectAll()
Selects all items.
OpenMS::Annotations1DContainer::deselectAll
void deselectAll()
Deselects all items.
OpenMS::Annotations1DContainer::setSelectedPen
void setSelectedPen(const QPen &pen)
Sets the selected_pen_.
OpenMS::Annotations1DContainer::pen_
QPen pen_
The pen used to draw items.
Definition: Annotations1DContainer.h:119
OpenMS::Annotations1DContainer::setPen
void setPen(const QPen &pen)
Sets the pen_.
OpenMS::Annotations1DContainer::selected_pen_
QPen selected_pen_
The pen used to draw selected items.
Definition: Annotations1DContainer.h:122
OpenMS::Annotations1DContainer::getPen
const QPen & getPen() const
Returns the pen_.
OpenMS::Annotations1DContainer::Annotations1DContainer
Annotations1DContainer()
Default constructor.
OpenMS::Annotation1DItem
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:59
OpenMS::Annotations1DContainer::deselectItemAt
void deselectItemAt(const QPoint &pos)
Deselects the item at pos on the canvas, if it exists.
OpenMS::Annotations1DContainer::ConstIterator
std::list< Annotation1DItem * >::const_iterator ConstIterator
Const iterator for the 1D annotations.
Definition: Annotations1DContainer.h:73
OpenMS::Annotations1DContainer::CoordinateType
double CoordinateType
Coordinate type.
Definition: Annotations1DContainer.h:79
OpenMS::Annotations1DContainer::PointType
DPosition< 2 > PointType
Type of the Points.
Definition: Annotations1DContainer.h:76
DPosition.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Annotations1DContainer::getSelectedItems
std::vector< Annotation1DItem * > getSelectedItems()
Returns the selected items.
OpenMS::DPosition< 2 >
OpenMS::Annotations1DContainer::getItemAt
Annotation1DItem * getItemAt(const QPoint &pos) const
Returns a pointer to the item at pos, or 0, if not existent.
OpenMS::Annotations1DContainer::operator=
Annotations1DContainer & operator=(const Annotations1DContainer &rhs)
Assignment operator.
OpenMS::Annotations1DContainer::removeSelectedItems
void removeSelectedItems()
Removes the selected items.
OpenMS::Annotations1DContainer::~Annotations1DContainer
virtual ~Annotations1DContainer()
Destructor.
OpenMS::Annotations1DContainer
Container for annotations to content of Spectrum1DCanvas.
Definition: Annotations1DContainer.h:53
OpenMS::Annotations1DContainer::selectItemAt
void selectItemAt(const QPoint &pos)
Selects the item at pos on the canvas, if it exists.
OpenMS::Annotations1DContainer::Iterator
std::list< Annotation1DItem * >::iterator Iterator
Iterator for the 1D annotations.
Definition: Annotations1DContainer.h:70
OpenMS::Annotations1DContainer::getSelectedPen
const QPen & getSelectedPen() const
Returns the selected_pen_.
QObject