Make annotation export customizable
[pulseview.git] / pv / views / trace / header.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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP
22
23 #include <list>
24 #include <memory>
25 #include <utility>
26
27 #include "marginwidget.hpp"
28
29 using std::shared_ptr;
30 using std::vector;
31
32 namespace pv {
33 namespace views {
34 namespace trace {
35
36 class TraceTreeItem;
37 class View;
38 class ViewItem;
39
40 /**
41  * The Header class provides an area for @ref Trace labels to be shown,
42  * trace-related settings to be edited, trace groups to be shown and similar.
43  * Essentially, it is the main management area of the @ref View itself and
44  * shown on the left-hand side of the trace area.
45  */
46 class Header : public MarginWidget
47 {
48         Q_OBJECT
49
50 private:
51         static const int Padding;
52
53 public:
54         Header(View &parent);
55
56         QSize sizeHint() const;
57
58         /**
59          * The extended area that the header widget would like to be sized to.
60          * @remarks This area is the area specified by sizeHint, extended by
61          * the area to overlap the viewport.
62          */
63         QSize extended_size_hint() const;
64
65 private:
66         /**
67          * Gets the row items.
68          */
69         vector< shared_ptr<ViewItem> > items();
70
71         /**
72          * Gets the first view item which has a label that contains @c pt .
73          * @param pt the point to search with.
74          * @return the view item that has been found, or and empty
75          *   @c shared_ptr if no item was found.
76          */
77         shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt);
78
79 private:
80         void paintEvent(QPaintEvent *event);
81
82 private:
83         void contextMenuEvent(QContextMenuEvent *event);
84
85         void keyPressEvent(QKeyEvent *event);
86
87 private Q_SLOTS:
88         void on_group();
89
90         void on_ungroup();
91 };
92
93 } // namespace trace
94 } // namespace views
95 } // namespace pv
96
97 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_HEADER_HPP