Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Annotation1DItem.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-2017.
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 #ifndef OPENMS_VISUAL_ANNOTATION_ANNOTATION1DITEM_H
36 #define OPENMS_VISUAL_ANNOTATION_ANNOTATION1DITEM_H
37 
39 
40 #include <QtCore/QRectF>
41 #include <QtCore/QString>
42 
43 class QPainter;
44 
45 namespace OpenMS
46 {
47  class Spectrum1DCanvas;
48 
61  {
62 
63 public:
66 
68  typedef float IntensityType;
69 
71  typedef double CoordinateType;
72 
74  virtual ~Annotation1DItem();
75 
77  const QRectF & boundingBox() const;
78 
80  bool isSelected() const;
81 
83  void setSelected(bool selected);
84 
86  void setText(const QString & text);
87 
89  const QString & getText() const;
90 
93  bool editText();
94 
96  virtual void ensureWithinDataRange(Spectrum1DCanvas * const canvas) = 0;
97 
99  virtual void draw(Spectrum1DCanvas * const canvas, QPainter & painter, bool flipped = false) = 0;
100 
102  virtual void move(const PointType & delta) = 0;
103 
104 protected:
106  Annotation1DItem(const QString & text);
107 
109  Annotation1DItem(const Annotation1DItem & rhs);
110 
112  void drawBoundingBox_(QPainter & painter);
113 
116 
118  bool selected_;
119 
121  QString text_;
122  };
123 } // namespace OpenMS
124 
125 #endif
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:60
bool selected_
Determines whether this item is currently selected on the canvas.
Definition: Annotation1DItem.h:118
bool isSelected() const
Returns true if this item is currently selected on the canvas, else false.
virtual ~Annotation1DItem()
Destructor.
virtual void draw(Spectrum1DCanvas *const canvas, QPainter &painter, bool flipped=false)=0
Draws the item on painter.
const QRectF & boundingBox() const
Returns the current bounding box of this item on the canvas where it has last been drawn...
void drawBoundingBox_(QPainter &painter)
Draws the bounding_box_.
Annotation1DItem(const QString &text)
Constructor.
const QString & getText() const
Returns the text of the item.
void setSelected(bool selected)
Sets whether this item is currently selected on the canvas or not.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
DPosition< 2 > PointType
Type of the Points.
Definition: Annotation1DItem.h:65
QRectF bounding_box_
The current bounding box of this item on the canvas where it has last been drawn. ...
Definition: Annotation1DItem.h:115
void setText(const QString &text)
Sets the text of the item.
Canvas for visualization of one or several spectra.
Definition: Spectrum1DCanvas.h:68
float IntensityType
Intensity type.
Definition: Annotation1DItem.h:68
double CoordinateType
Coordinate type.
Definition: Annotation1DItem.h:71
virtual void ensureWithinDataRange(Spectrum1DCanvas *const canvas)=0
Ensures that the item has coordinates within the visible area of the canvas.
virtual void move(const PointType &delta)=0
Moves the item; behaviour depends on item type and is implemented in the subclasses.
QString text_
The displayed text.
Definition: Annotation1DItem.h:121

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13