Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Annotation1DCaret.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_VISUAL_ANNOTATION_ANNOTATION1DCARET_H
36 #define OPENMS_VISUAL_ANNOTATION_ANNOTATION1DCARET_H
37 
39 
40 #include <QtGui/QColor>
41 #include <QStaticText>
42 #include <QTextDocument>
43 
44 #include <vector>
45 
46 namespace OpenMS
47 {
56  public Annotation1DItem
57  {
58 public:
59 
61  typedef std::vector<PointType> PositionsType;
62 
64  Annotation1DCaret(const PositionsType& poly_positions, const QString& text, const QColor& colour, const QColor& connection_line_color);
65 
68 
70  virtual ~Annotation1DCaret();
71 
72  // Docu in base class
73  virtual void ensureWithinDataRange(Spectrum1DCanvas* const canvas);
74 
75  // Docu in base class
76  virtual void draw(Spectrum1DCanvas* const canvas, QPainter& painter, bool flipped = false);
77 
78  // Docu in base class
79  virtual void move(const PointType& delta);
80 
82  const PositionsType& getCaretPositions() const;
83 
85  void setPosition(const PointType& position);
86 
88  const PointType& getPosition() const;
89 
91  void setColor(const QColor& color);
92 
94  const QColor& getColor() const;
95 
98  void setRichText(const QString& text);
99 
100 protected:
101 
104  PositionsType caret_positions_;
105 
107  PointType position_;
108 
110  QColor color_;
111 
114 
116  QStaticText st_;
117 
118  };
119 } // namespace OpenMS
120 
121 #endif
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:60
Annotation1DItem::PointType PointType
Definition: Annotation1DCaret.h:60
std::vector< PointType > PositionsType
Definition: Annotation1DCaret.h:61
virtual ~Annotation1DCaret()
Destructor.
QStaticText st_
Holds the (rich) text.
Definition: Annotation1DCaret.h:116
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Annotation1DCaret(const PositionsType &poly_positions, const QString &text, const QColor &colour, const QColor &connection_line_color)
Constructor.
const PointType & getPosition() const
Returns the position of the annotated peak (in MZ / intensity coordinates)
const QColor & getColor() const
Returns the colour of the carets.
An annotation item which paints a set of carets on the canvas.
Definition: Annotation1DCaret.h:55
void setPosition(const PointType &position)
Sets the position of the label (in MZ / intensity coordinates)
const PositionsType & getCaretPositions() const
Returns the positions of the lines (in MZ / intensity coordinates)
PositionsType caret_positions_
Definition: Annotation1DCaret.h:104
PointType position_
The position of the label (in MZ/intensity coordinates)
Definition: Annotation1DCaret.h:107
virtual void move(const PointType &delta)
Moves the item; behaviour depends on item type and is implemented in the subclasses.
virtual void ensureWithinDataRange(Spectrum1DCanvas *const canvas)
Ensures that the item has coordinates within the visible area of the canvas.
Canvas for visualization of one or several spectra.
Definition: Spectrum1DCanvas.h:68
void setRichText(const QString &text)
QColor connection_line_color_
The colour of the (optional) dashed line connecting peak and label.
Definition: Annotation1DCaret.h:113
QColor color_
The colour of the label.
Definition: Annotation1DCaret.h:110
virtual void draw(Spectrum1DCanvas *const canvas, QPainter &painter, bool flipped=false)
Draws the item on painter.
void setColor(const QColor &color)
Set the colour of the carets (colour of text must be set using html)

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