Implement annotation export for all rows
[pulseview.git] / pv / views / trace / flag.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_FLAG_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_FLAG_HPP
22
23 #include <memory>
24
25 #include "timemarker.hpp"
26
27 using std::enable_shared_from_this;
28
29 class QMenu;
30
31 namespace pv {
32 namespace views {
33 namespace trace {
34
35 /**
36  * The Flag class represents items on the @ref Ruler that mark important
37  * events on the timeline to the user. They are editable and thus non-static.
38  */
39 class Flag : public TimeMarker, public enable_shared_from_this<Flag>
40 {
41         Q_OBJECT
42
43 public:
44         static const QColor FillColor;
45
46 public:
47         /**
48          * Constructor.
49          * @param view A reference to the view that owns this cursor pair.
50          * @param time The time to set the flag to.
51          * @param text The text of the marker.
52          */
53         Flag(View &view, const pv::util::Timestamp& time, const QString &text);
54
55         /**
56          * Copy constructor.
57          */
58         Flag(const Flag &flag);
59
60         /**
61          * Returns true if the item is visible and enabled.
62          */
63         bool enabled() const;
64
65         /**
66          * Gets the text to show in the marker.
67          */
68         QString get_text() const;
69
70         pv::widgets::Popup* create_popup(QWidget *parent);
71
72         QMenu* create_header_context_menu(QWidget *parent);
73
74         void delete_pressed();
75
76 private Q_SLOTS:
77         void on_delete();
78
79         void on_text_changed(const QString &text);
80
81 private:
82         QString text_;
83 };
84
85 } // namespace trace
86 } // namespace views
87 } // namespace pv
88
89 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_FLAG_HPP