OpenMS  3.0.0
Annotation1DTextItem.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-2022.
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: Johannes Junker, Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
45  public Annotation1DItem
46  {
47 public:
48 
50  Annotation1DTextItem(const PointType & position, const QString & text, const int flags = Qt::AlignCenter);
51 
54 
56  ~Annotation1DTextItem() override;
57 
58  // Docu in base class
59  void ensureWithinDataRange(Plot1DCanvas * const canvas) override;
60 
61  // Docu in base class
62  void draw(Plot1DCanvas * const canvas, QPainter & painter, bool flipped = false) override;
63 
64  // Docu in base class
65  void move(const PointType & delta) override;
66 
68  void setPosition(const PointType & position);
69 
71  const PointType & getPosition() const;
72 
74  void setFlags(int flags);
75 
77  int getFlags() const;
78 
79 protected:
80 
83 
84  int flags_;
85  };
86 } // namespace OpenMS
87 
OpenMS::Plot1DCanvas
Canvas for visualization of one or several spectra.
Definition: Plot1DCanvas.h:70
OpenMS::Annotation1DTextItem
An annotation item which represents an arbitrary text on the canvas.
Definition: Annotation1DTextItem.h:44
Annotation1DItem.h
OpenMS::Annotation1DTextItem::move
void move(const PointType &delta) override
Moves the item; behaviour depends on item type and is implemented in the subclasses.
OpenMS::Annotation1DTextItem::setFlags
void setFlags(int flags)
Set Qt flags (default: Qt::AlignCenter)
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Annotation1DTextItem::position_
PointType position_
The position of the item (in MZ / intensity coordinates)
Definition: Annotation1DTextItem.h:82
OpenMS::Annotation1DTextItem::getPosition
const PointType & getPosition() const
Returns the position of the item (in MZ / intensity coordinates)
OpenMS::Annotation1DTextItem::flags_
int flags_
Definition: Annotation1DTextItem.h:84
OpenMS::Annotation1DItem
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:59
OpenMS::DPosition< 2 >
OpenMS::Annotation1DTextItem::Annotation1DTextItem
Annotation1DTextItem(const PointType &position, const QString &text, const int flags=Qt::AlignCenter)
Constructor.
OpenMS::Annotation1DTextItem::draw
void draw(Plot1DCanvas *const canvas, QPainter &painter, bool flipped=false) override
Draws the item on painter.
OpenMS::Annotation1DTextItem::getFlags
int getFlags() const
Get Qt flags.
OpenMS::Annotation1DTextItem::setPosition
void setPosition(const PointType &position)
Sets the position of the item (in MZ / intensity coordinates)
OpenMS::Annotation1DTextItem::~Annotation1DTextItem
~Annotation1DTextItem() override
Destructor.
OpenMS::Annotation1DTextItem::ensureWithinDataRange
void ensureWithinDataRange(Plot1DCanvas *const canvas) override
Ensures that the item has coordinates within the visible area of the canvas.