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/fixed.h>
28 #include <gtkmm/frame.h>
29 #include <gtkmm/drawingarea.h>
30 #include <gtkmm/eventbox.h>
31 #include <gtkmm/table.h>
32 #include <gtkmm/entry.h>
33 #include <gtkmm/label.h>
34 #include <gtkmm/sizegroup.h>
36 #include <gtkmm2ext/focus_entry.h>
38 #include "pbd/stateful.h"
39 #include "pbd/signals.h"
41 #include "ardour/types.h"
42 #include "ardour/region.h"
43 #include "evoral/Parameter.hpp"
45 #include "canvas/line.h"
48 #include "axis_view.h"
64 namespace ArdourCanvas {
71 class RegionSelection;
74 class TimeAxisViewItem;
82 /** Abstract base class for time-axis views (horizontal editor 'strips')
84 * This class provides the basic LHS controls and display methods. This should be
85 * extended to create functional time-axis based views.
87 class TimeAxisView : public virtual AxisView
90 enum NamePackingBits {
91 NameLabelPacked = 0x1,
96 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
97 virtual ~TimeAxisView ();
99 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
101 /** @return index of this TimeAxisView within its parent */
102 int order () const { return _order; }
104 /** @return maximum allowable value of order */
105 static int max_order () { return _max_order; }
107 virtual void enter_internal_edit_mode () {}
108 virtual void leave_internal_edit_mode () {}
110 ArdourCanvas::Container* canvas_display () { return _canvas_display; }
111 ArdourCanvas::Container* ghost_group () { return _ghost_group; }
113 /** @return effective height (taking children into account) in canvas units, or
114 0 if this TimeAxisView has not yet been shown */
115 uint32_t effective_height () const { return _effective_height; }
117 /** @return y position, or -1 if hidden */
118 double y_position () const { return _y_position; }
120 /** @return our Editor */
121 PublicEditor& editor () const { return _editor; }
123 uint32_t current_height() const { return height; }
125 void idle_resize (uint32_t);
127 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
128 virtual void hide ();
130 bool touched (double top, double bot);
132 /** @return true if hidden, otherwise false */
133 bool hidden () const { return _hidden; }
135 void set_selected (bool);
138 * potential handler for entered events
141 virtual void entered () {}
142 virtual void exited () {}
144 virtual void set_height (uint32_t h);
145 void set_height_enum (Height, bool apply_to_selection = false);
148 virtual void reset_visual_state ();
150 std::pair<TimeAxisView*, double> covers_y_position (double) const;
151 bool covered_by_y_range (double y0, double y1) const;
153 virtual void step_height (bool);
155 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
156 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
158 virtual void set_samples_per_pixel (double);
159 virtual void show_selection (TimeSelection&);
160 virtual void hide_selection ();
161 virtual void reshow_selection (TimeSelection&);
162 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
163 virtual void hide_timestretch ();
165 /* editing operations */
167 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
168 virtual bool paste (ARDOUR::framepos_t, unsigned /*paste_count*/, float /*times*/, Selection&, size_t /*nth*/) { return false; }
170 virtual void set_selected_regionviews (RegionSelection&) {}
171 virtual void set_selected_points (PointSelection&) {}
173 virtual void fade_range (TimeSelection&) {}
175 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
176 return boost::shared_ptr<ARDOUR::Region> ();
179 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
181 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
182 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
184 void add_ghost (RegionView*);
185 void remove_ghost (RegionView*);
186 void erase_ghost (GhostRegion*);
188 /** called at load time when first GUI idle occurs. put
189 expensive data loading/redisplay code in here. */
190 virtual void first_idle () {}
192 TimeAxisView* get_parent () { return parent; }
193 void set_parent (TimeAxisView& p);
195 virtual LayerDisplay layer_display () const { return Overlaid; }
196 virtual StreamView* view () const { return 0; }
198 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
199 Children get_child_list ();
201 SelectionRect* get_selection_rect(uint32_t id);
203 static uint32_t preset_height (Height);
206 static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
207 static Glib::RefPtr<Gtk::SizeGroup> midi_scroomer_size_group;
208 static unsigned int name_width_px;
209 /* The Standard LHS Controls */
210 Gtk::Table controls_table;
211 Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
212 Gtk::EventBox controls_ebox;
213 Gtk::VBox controls_vbox;
214 Gtk::VBox time_axis_vbox;
215 Gtk::HBox time_axis_hbox;
216 Gtk::Frame time_axis_frame;
219 Gtk::Label name_label;
220 Gtk::Fixed scroomer_placeholder;
222 uint32_t height; /* in canvas units */
223 std::string controls_base_unselected_name;
224 std::string controls_base_selected_name;
225 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
226 TimeAxisView* parent;
227 ArdourCanvas::Container* selection_group;
228 ArdourCanvas::Container* _ghost_group;
229 std::list<GhostRegion*> ghosts;
230 std::list<SelectionRect*> free_selection_rects;
231 std::list<SelectionRect*> used_selection_rects;
234 Gtk::Menu* _size_menu;
235 ArdourCanvas::Line* _canvas_separator;
236 ArdourCanvas::Container* _canvas_display;
238 PublicEditor& _editor;
240 virtual bool can_edit_name() const;
242 bool name_entry_key_release (GdkEventKey *ev);
243 bool name_entry_key_press (GdkEventKey *ev);
244 bool name_entry_focus_out (GdkEventFocus *ev);
246 Gtk::Entry* name_entry;
247 void begin_name_edit ();
248 void end_name_edit (int);
250 /* derived classes can override these */
252 virtual void name_entry_changed ();
254 /** Handle mouse relaese on our LHS control name ebox.
256 *@ param ev the event
258 virtual bool controls_ebox_button_release (GdkEventButton*);
259 virtual bool controls_ebox_scroll (GdkEventScroll*);
260 virtual bool controls_ebox_button_press (GdkEventButton*);
261 virtual bool controls_ebox_motion (GdkEventMotion*);
262 virtual bool controls_ebox_leave (GdkEventCrossing*);
264 /** Display the standard LHS control menu at when.
266 * @param when the popup activation time
268 virtual void popup_display_menu (guint32 when);
270 /** Build the standard LHS control menu.
271 * Subclasses should extend this method to add their own menu options.
273 virtual void build_display_menu ();
275 /** Do whatever needs to be done to dynamically reset the LHS control menu.
277 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
280 bool is_child (TimeAxisView*);
282 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
283 void add_child (boost::shared_ptr<TimeAxisView>);
285 /* selection display */
287 virtual void selection_click (GdkEventButton*);
289 void color_handler ();
291 void conditionally_add_to_selection ();
293 void build_size_menu ();
296 Gtk::VBox* control_parent;
298 uint32_t _effective_height;
299 double _resize_drag_start;
301 GdkCursor* _preresize_cursor;
302 bool _have_preresize_cursor;
303 bool _ebox_release_can_act;
305 static uint32_t button_height;
306 static uint32_t extra_height;
307 static int const _max_order;
309 void compute_heights ();
310 bool maybe_set_cursor (int y);
312 }; /* class TimeAxisView */
314 #endif /* __ardour_gtk_time_axis_h__ */