Add a tooltip for the "Stack decoder" button/dropdown.
[pulseview.git] / pv / view / trace.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2013 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 #include <extdef.h>
21
22 #include <cassert>
23 #include <cmath>
24
25 #include <QApplication>
26 #include <QFormLayout>
27 #include <QKeyEvent>
28 #include <QLineEdit>
29
30 #include "trace.hpp"
31 #include "tracepalette.hpp"
32 #include "view.hpp"
33
34 #include "pv/globalsettings.hpp"
35 #include "pv/widgets/colourbutton.hpp"
36 #include "pv/widgets/popup.hpp"
37
38 using std::pair;
39 using std::shared_ptr;
40
41 namespace pv {
42 namespace views {
43 namespace TraceView {
44
45 const QPen Trace::AxisPen(QColor(0, 0, 0, 30 * 256 / 100));
46 const int Trace::LabelHitPadding = 2;
47
48 const QColor Trace::BrightGrayBGColour = QColor(0, 0, 0, 10 * 255 / 100);
49 const QColor Trace::DarkGrayBGColour = QColor(0, 0, 0, 15 * 255 / 100);
50
51 Trace::Trace(shared_ptr<data::SignalBase> channel) :
52         base_(channel),
53         popup_(nullptr),
54         popup_form_(nullptr)
55 {
56         GlobalSettings settings;
57         coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
58
59         connect(channel.get(), SIGNAL(name_changed(const QString&)),
60                 this, SLOT(on_name_changed(const QString&)));
61         connect(channel.get(), SIGNAL(colour_changed(const QColor&)),
62                 this, SLOT(on_colour_changed(const QColor&)));
63 }
64
65 void Trace::set_coloured_bg(bool state)
66 {
67         coloured_bg_ = state;
68 }
69
70 void Trace::paint_label(QPainter &p, const QRect &rect, bool hover)
71 {
72         const int y = get_visual_y();
73
74         p.setBrush(base_->colour());
75
76         if (!enabled())
77                 return;
78
79         const QRectF r = label_rect(rect);
80
81         // Paint the label
82         const float label_arrow_length = r.height() / 2;
83         const QPointF points[] = {
84                 r.topLeft(),
85                 QPointF(r.right() - label_arrow_length, r.top()),
86                 QPointF(r.right(), y),
87                 QPointF(r.right() - label_arrow_length, r.bottom()),
88                 r.bottomLeft()
89         };
90         const QPointF highlight_points[] = {
91                 QPointF(r.left() + 1, r.top() + 1),
92                 QPointF(r.right() - label_arrow_length, r.top() + 1),
93                 QPointF(r.right() - 1, y),
94                 QPointF(r.right() - label_arrow_length, r.bottom() - 1),
95                 QPointF(r.left() + 1, r.bottom() - 1)
96         };
97
98         if (selected()) {
99                 p.setPen(highlight_pen());
100                 p.setBrush(Qt::transparent);
101                 p.drawPolygon(points, countof(points));
102         }
103
104         p.setPen(Qt::transparent);
105         p.setBrush(hover ? base_->colour().lighter() : base_->colour());
106         p.drawPolygon(points, countof(points));
107
108         p.setPen(base_->colour().lighter());
109         p.setBrush(Qt::transparent);
110         p.drawPolygon(highlight_points, countof(highlight_points));
111
112         p.setPen(base_->colour().darker());
113         p.setBrush(Qt::transparent);
114         p.drawPolygon(points, countof(points));
115
116         // Paint the text
117         p.setPen(select_text_colour(base_->colour()));
118         p.setFont(QApplication::font());
119         p.drawText(QRectF(r.x(), r.y(),
120                 r.width() - label_arrow_length, r.height()),
121                 Qt::AlignCenter | Qt::AlignVCenter, base_->name());
122 }
123
124 QMenu* Trace::create_context_menu(QWidget *parent)
125 {
126         QMenu *const menu = ViewItem::create_context_menu(parent);
127
128         return menu;
129 }
130
131 pv::widgets::Popup* Trace::create_popup(QWidget *parent)
132 {
133         using pv::widgets::Popup;
134
135         popup_ = new Popup(parent);
136         popup_->set_position(parent->mapToGlobal(
137                 point(parent->rect())), Popup::Right);
138
139         create_popup_form();
140
141         connect(popup_, SIGNAL(closed()), this, SLOT(on_popup_closed()));
142
143         return popup_;
144 }
145
146 QRectF Trace::label_rect(const QRectF &rect) const
147 {
148         QFontMetrics m(QApplication::font());
149         const QSize text_size(
150                 m.boundingRect(QRect(), 0, base_->name()).width(), m.height());
151         const QSizeF label_size(
152                 text_size.width() + LabelPadding.width() * 2,
153                 ceilf((text_size.height() + LabelPadding.height() * 2) / 2) * 2);
154         const float half_height = label_size.height() / 2;
155         return QRectF(
156                 rect.right() - half_height - label_size.width() - 0.5,
157                 get_visual_y() + 0.5f - half_height,
158                 label_size.width() + half_height,
159                 label_size.height());
160 }
161
162 void Trace::paint_back(QPainter &p, const ViewItemPaintParams &pp)
163 {
164         if (coloured_bg_)
165                 p.setBrush(base_->bgcolour());
166         else
167                 p.setBrush(bgcolour_state_ ? BrightGrayBGColour : DarkGrayBGColour);
168
169         p.setPen(QPen(Qt::NoPen));
170
171         const pair<int, int> extents = v_extents();
172
173         const int x = 0;
174         const int y = get_visual_y() + extents.first;
175         const int w = pp.right() - pp.left();
176         const int h = extents.second - extents.first;
177
178         p.drawRect(x, y, w, h);
179 }
180
181 void Trace::paint_axis(QPainter &p, const ViewItemPaintParams &pp, int y)
182 {
183         p.setRenderHint(QPainter::Antialiasing, false);
184
185         p.setPen(AxisPen);
186         p.drawLine(QPointF(pp.left(), y), QPointF(pp.right(), y));
187
188         p.setRenderHint(QPainter::Antialiasing, true);
189 }
190
191 void Trace::add_colour_option(QWidget *parent, QFormLayout *form)
192 {
193         using pv::widgets::ColourButton;
194
195         ColourButton *const colour_button = new ColourButton(
196                 TracePalette::Rows, TracePalette::Cols, parent);
197         colour_button->set_palette(TracePalette::Colours);
198         colour_button->set_colour(base_->colour());
199         connect(colour_button, SIGNAL(selected(const QColor&)),
200                 this, SLOT(on_colouredit_changed(const QColor&)));
201
202         form->addRow(tr("Colour"), colour_button);
203 }
204
205 void Trace::create_popup_form()
206 {
207         // Clear the layout
208
209         // Transfer the layout and the child widgets to a temporary widget
210         // which we delete after the event was handled. This way, the layout
211         // and all widgets contained therein are deleted after the event was
212         // handled, leaving the parent popup_ time to handle the change.
213         if (popup_form_) {
214                 QWidget *suicidal = new QWidget();
215                 suicidal->setLayout(popup_form_);
216                 suicidal->deleteLater();
217         }
218
219         // Repopulate the popup
220         popup_form_ = new QFormLayout(popup_);
221         popup_->setLayout(popup_form_);
222         populate_popup_form(popup_, popup_form_);
223 }
224
225 void Trace::populate_popup_form(QWidget *parent, QFormLayout *form)
226 {
227         QLineEdit *const name_edit = new QLineEdit(parent);
228         name_edit->setText(base_->name());
229         connect(name_edit, SIGNAL(textChanged(const QString&)),
230                 this, SLOT(on_nameedit_changed(const QString&)));
231         form->addRow(tr("Name"), name_edit);
232
233         add_colour_option(parent, form);
234 }
235
236 void Trace::set_name(QString name)
237 {
238         base_->set_name(name);
239 }
240
241 void Trace::set_colour(QColor colour)
242 {
243         base_->set_colour(colour);
244 }
245
246 void Trace::on_name_changed(const QString &text)
247 {
248         /* This event handler is called by SignalBase when the name was changed there */
249         (void)text;
250
251         if (owner_) {
252                 owner_->extents_changed(true, false);
253                 owner_->row_item_appearance_changed(true, false);
254         }
255 }
256
257 void Trace::on_colour_changed(const QColor &colour)
258 {
259         /* This event handler is called by SignalBase when the colour was changed there */
260         (void)colour;
261
262         if (owner_)
263                 owner_->row_item_appearance_changed(true, true);
264 }
265
266 void Trace::on_popup_closed()
267 {
268         popup_ = nullptr;
269         popup_form_ = nullptr;
270 }
271
272 void Trace::on_nameedit_changed(const QString &name)
273 {
274         /* This event handler notifies SignalBase that the name changed */
275         set_name(name);
276 }
277
278 void Trace::on_colouredit_changed(const QColor &colour)
279 {
280         /* This event handler notifies SignalBase that the colour changed */
281         set_colour(colour);
282 }
283
284 } // namespace TraceView
285 } // namespace views
286 } // namespace pv