2 Copyright (C) 2003 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_gtk_time_axis_h__
21 #define __ardour_gtk_time_axis_h__
26 #include <gtkmm/box.h>
27 #include <gtkmm/frame.h>
28 #include <gtkmm/drawingarea.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/table.h>
31 #include <gtkmm/entry.h>
32 #include <gtkmm/label.h>
34 #include <gtkmm2ext/focus_entry.h>
36 #include "pbd/stateful.h"
38 #include "ardour/types.h"
39 #include "ardour/region.h"
40 #include "evoral/Parameter.hpp"
43 #include "axis_view.h"
61 class RegionSelection;
64 class TimeAxisViewItem;
71 /** Abstract base class for time-axis views (horizontal editor 'strips')
73 * This class provides the basic LHS controls and display methods. This should be
74 * extended to create functional time-axis based views.
76 class TimeAxisView : public virtual AxisView, public PBD::Stateful
79 enum NamePackingBits {
80 NameLabelPacked = 0x1,
85 static uint32_t hLargest;
86 static uint32_t hLarge;
87 static uint32_t hLarger;
88 static uint32_t hNormal;
89 static uint32_t hSmaller;
90 static uint32_t hSmall;
92 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
93 virtual ~TimeAxisView ();
95 XMLNode& get_state ();
96 int set_state (const XMLNode&);
98 /** @return index of this TimeAxisView within its parent */
99 int order () const { return _order; }
101 /** @return maximum allowable value of order */
102 static int max_order () { return _max_order; }
104 ArdourCanvas::Group* canvas_display () { return _canvas_display; }
105 ArdourCanvas::Group* canvas_background () { return _canvas_background; }
106 ArdourCanvas::Group* ghost_group () { return _ghost_group; }
108 /** @return effective height (taking children into account) in canvas units, or
109 0 if this TimeAxisView has not yet been shown */
110 uint32_t effective_height () const { return _effective_height; }
112 /** @return y position, or -1 if hidden */
113 double y_position () const { return _y_position; }
115 /** @return our Editor */
116 PublicEditor& editor () const { return _editor; }
118 uint32_t current_height() const { return height; }
120 bool resizer_button_press (GdkEventButton*);
121 bool resizer_button_release (GdkEventButton*);
122 bool resizer_motion (GdkEventMotion*);
123 bool resizer_expose (GdkEventExpose*);
125 void idle_resize (uint32_t);
127 void hide_name_label ();
128 void hide_name_entry ();
129 void show_name_label ();
130 void show_name_entry ();
132 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
134 void clip_to_viewport ();
136 bool touched (double top, double bot);
138 /** Hide this TrackView */
139 virtual void hide ();
141 /** @return true if hidden, otherwise false */
142 bool hidden () const { return _hidden; }
144 virtual void set_selected (bool);
147 * potential handler for entered events
150 virtual void entered () {}
151 virtual void exited () {}
153 virtual void set_height (uint32_t h);
156 std::pair<TimeAxisView*, ARDOUR::layer_t> covers_y_position (double);
159 * Steps through the defined heights for this TrackView.
160 * Sets bigger to true to step up in size, set to fals eot step smaller.
162 * @param bigger true if stepping should increase in size, false otherwise
164 virtual void step_height (bool bigger);
166 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
167 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
169 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
170 virtual void hide_feature_lines ();
172 virtual void set_samples_per_unit (double);
173 virtual void show_selection (TimeSelection&);
174 virtual void hide_selection ();
175 virtual void reshow_selection (TimeSelection&);
176 virtual void show_timestretch (nframes_t start, nframes_t end);
177 virtual void hide_timestretch ();
179 virtual void hide_dependent_views (TimeAxisViewItem&) {}
180 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
182 /* editing operations */
184 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
185 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
187 virtual void set_selected_regionviews (RegionSelection&) {}
188 virtual void set_selected_points (PointSelection&) {}
190 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
191 return boost::shared_ptr<ARDOUR::Region> ();
194 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
196 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, std::list<Selectable*>& results);
197 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
199 void add_ghost (RegionView*);
200 void remove_ghost (RegionView*);
201 void erase_ghost (GhostRegion*);
203 /** called at load time when first GUI idle occurs. put
204 expensive data loading/redisplay code in here. */
205 virtual void first_idle () {}
207 TimeAxisView* get_parent () { return parent; }
208 void set_parent (TimeAxisView& p);
209 bool has_state () const;
211 /* call this on the parent */
213 virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param) { return 0; }
215 virtual LayerDisplay layer_display () const { return Overlaid; }
216 virtual StreamView* view () const { return 0; }
218 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
221 /* The Standard LHS Controls */
222 Gtk::HBox controls_hbox;
223 Gtk::Table controls_table;
224 Gtk::EventBox controls_ebox;
225 Gtk::VBox controls_vbox;
226 Gtk::DrawingArea resizer;
227 Gtk::HBox resizer_box;
229 Gtk::Frame name_frame;
230 Gtkmm2ext::FocusEntry name_entry;
232 uint32_t height; /* in canvas units */
234 std::string controls_base_unselected_name;
235 std::string controls_base_selected_name;
237 bool name_entry_button_press (GdkEventButton *ev);
238 bool name_entry_button_release (GdkEventButton *ev);
239 bool name_entry_key_release (GdkEventKey *ev);
240 void name_entry_activated ();
241 sigc::connection name_entry_key_timeout;
242 bool name_entry_key_timed_out ();
243 guint32 last_name_entry_key_press_event;
245 /* derived classes can override these */
247 virtual void name_entry_changed ();
248 virtual bool name_entry_focus_in (GdkEventFocus *ev);
249 virtual bool name_entry_focus_out (GdkEventFocus *ev);
251 /** Handle mouse relaese on our LHS control name ebox.
253 *@ param ev the event
255 virtual bool controls_ebox_button_release (GdkEventButton *ev);
256 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
258 /** Display the standard LHS control menu at when.
260 * @param when the popup activation time
262 virtual void popup_display_menu (guint32 when);
264 /** Build the standard LHS control menu.
265 * Subclasses should extend this method to add their own menu options.
267 virtual void build_display_menu ();
269 /** Do whatever needs to be done to dynamically reset the LHS control menu.
271 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
273 /** Build the standard LHS control size menu for the default heights options.
275 virtual void build_size_menu();
277 /** Displays the standard LHS controls size menu for the track heights
279 * @param when the popup activation time
281 void popup_size_menu(guint32 when);
283 /** Handle the size option of our main menu.
285 * @param ev the event
287 gint size_click(GdkEventButton *ev);
289 /* The standard LHS Track control popup-menus */
291 Gtk::Menu *display_menu;
292 Gtk::Menu *size_menu;
294 Gtk::Label name_label;
296 TimeAxisView* parent;
298 /** Find the parent with state */
299 TimeAxisView* get_parent_with_state();
302 bool is_child (TimeAxisView*);
304 void remove_child (boost::shared_ptr<TimeAxisView>);
305 void add_child (boost::shared_ptr<TimeAxisView>);
307 /* selection display */
309 ArdourCanvas::Group *selection_group;
311 std::list<GhostRegion*> ghosts;
313 std::list<SelectionRect*> free_selection_rects;
314 std::list<SelectionRect*> used_selection_rects;
316 SelectionRect* get_selection_rect(uint32_t id);
318 virtual void selection_click (GdkEventButton*);
323 NamePackingBits name_packing;
325 static void compute_controls_size_info ();
326 static bool need_size_info;
328 void set_heights (uint32_t h);
329 void color_handler ();
331 std::list<ArdourCanvas::SimpleLine*> feature_lines;
332 ARDOUR::AnalysisFeatureList analysis_features;
333 void reshow_feature_lines ();
335 void conditionally_add_to_selection ();
337 ArdourCanvas::Group* _canvas_display;
339 PublicEditor& _editor;
343 ArdourCanvas::Group* _canvas_background;
344 Gtk::VBox* control_parent;
346 uint32_t _effective_height;
347 double _resize_drag_start;
348 ArdourCanvas::Group* _ghost_group;
350 static int const _max_order;
352 }; /* class TimeAxisView */
354 #endif /* __ardour_gtk_time_axis_h__ */