Save/restore view states and signal settings
[pulseview.git] / pv / view / signal.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_VIEW_SIGNAL_HPP
22 #define PULSEVIEW_PV_VIEW_SIGNAL_HPP
23
24 #include <memory>
25
26 #include <QComboBox>
27 #include <QWidgetAction>
28
29 #include <stdint.h>
30
31 #include "signalscalehandle.hpp"
32 #include "trace.hpp"
33 #include "viewitemowner.hpp"
34
35 namespace pv {
36
37 class Session;
38
39 namespace data {
40 class SignalBase;
41 class SignalData;
42 }
43
44 namespace view {
45
46 class Signal : public Trace, public ViewItemOwner
47 {
48         Q_OBJECT
49
50 protected:
51         Signal(pv::Session &session,
52                 std::shared_ptr<data::SignalBase> channel);
53
54 public:
55         /**
56          * Sets the name of the signal.
57          */
58         virtual void set_name(QString name);
59
60         virtual std::shared_ptr<pv::data::SignalData> data() const = 0;
61
62         /**
63          * Returns true if the trace is visible and enabled.
64          */
65         bool enabled() const;
66
67         std::shared_ptr<data::SignalBase> base() const;
68
69         virtual void save_settings(QSettings &settings) const;
70
71         virtual void restore_settings(QSettings &settings);
72
73         /**
74          * Returns a list of row items owned by this object.
75          */
76         const item_list& child_items() const;
77
78         void paint_back(QPainter &p, const ViewItemPaintParams &pp);
79
80         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
81
82         QMenu* create_context_menu(QWidget *parent);
83
84         void delete_pressed();
85
86         /**
87          * Returns the offset to show the drag handle.
88          */
89         virtual int scale_handle_offset() const = 0;
90
91         /**
92          * Handles the scale handle being dragged to an offset.
93          * @param offset the offset the scale handle was dragged to.
94          */
95         virtual void scale_handle_dragged(int offset) = 0;
96
97         /**
98          * Handles the scale handle being being released.
99          */
100         virtual void scale_handle_released() {};
101
102 protected Q_SLOTS:
103         virtual void on_name_changed(const QString &text);
104
105         void on_disable();
106
107         void on_enabled_changed(bool enabled);
108
109 protected:
110         pv::Session &session_;
111
112         const std::shared_ptr<SignalScaleHandle> scale_handle_;
113         const item_list items_;
114
115         QComboBox *name_widget_;
116 };
117
118 } // namespace view
119 } // namespace pv
120
121 #endif // PULSEVIEW_PV_VIEW_SIGNAL_HPP