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"
37 #include "pbd/signals.h"
39 #include "ardour/types.h"
40 #include "ardour/region.h"
41 #include "evoral/Parameter.hpp"
44 #include "axis_view.h"
62 class RegionSelection
;
65 class TimeAxisViewItem
;
72 /** Abstract base class for time-axis views (horizontal editor 'strips')
74 * This class provides the basic LHS controls and display methods. This should be
75 * extended to create functional time-axis based views.
77 class TimeAxisView
: public virtual AxisView
80 enum NamePackingBits
{
81 NameLabelPacked
= 0x1,
87 TimeAxisView(ARDOUR::Session
* sess
, PublicEditor
& ed
, TimeAxisView
* parent
, ArdourCanvas::Canvas
& canvas
);
88 virtual ~TimeAxisView ();
90 static PBD::Signal1
<void,TimeAxisView
*> CatchDeletion
;
92 /** @return index of this TimeAxisView within its parent */
93 int order () const { return _order
; }
95 /** @return maximum allowable value of order */
96 static int max_order () { return _max_order
; }
98 virtual void enter_internal_edit_mode () {}
99 virtual void leave_internal_edit_mode () {}
101 ArdourCanvas::Group
* canvas_display () { return _canvas_display
; }
102 ArdourCanvas::Group
* canvas_background () { return _canvas_background
; }
103 ArdourCanvas::Group
* ghost_group () { return _ghost_group
; }
105 /** @return effective height (taking children into account) in canvas units, or
106 0 if this TimeAxisView has not yet been shown */
107 uint32_t effective_height () const { return _effective_height
; }
109 /** @return y position, or -1 if hidden */
110 double y_position () const { return _y_position
; }
112 /** @return our Editor */
113 PublicEditor
& editor () const { return _editor
; }
115 uint32_t current_height() const { return height
; }
117 void idle_resize (uint32_t);
119 void hide_name_label ();
120 void hide_name_entry ();
121 void show_name_label ();
122 void show_name_entry ();
124 virtual guint32
show_at (double y
, int& nth
, Gtk::VBox
*parent
);
125 virtual void hide ();
127 void clip_to_viewport ();
129 bool touched (double top
, double bot
);
131 /** @return true if hidden, otherwise false */
132 bool hidden () const { return _hidden
; }
134 virtual void set_selected (bool);
137 * potential handler for entered events
140 virtual void entered () {}
141 virtual void exited () {}
143 virtual void set_height (uint32_t h
);
144 void set_height_enum (Height
, bool apply_to_selection
= false);
147 virtual void reset_visual_state ();
149 std::pair
<TimeAxisView
*, ARDOUR::layer_t
> covers_y_position (double);
151 virtual void step_height (bool);
153 virtual ARDOUR::RouteGroup
* route_group() const { return 0; }
154 virtual boost::shared_ptr
<ARDOUR::Playlist
> playlist() const { return boost::shared_ptr
<ARDOUR::Playlist
> (); }
156 virtual void set_samples_per_unit (double);
157 virtual void show_selection (TimeSelection
&);
158 virtual void hide_selection ();
159 virtual void reshow_selection (TimeSelection
&);
160 virtual void show_timestretch (framepos_t start
, framepos_t end
);
161 virtual void hide_timestretch ();
163 virtual void hide_dependent_views (TimeAxisViewItem
&) {}
164 virtual void reveal_dependent_views (TimeAxisViewItem
&) {}
166 /* editing operations */
168 virtual void cut_copy_clear (Selection
&, Editing::CutCopyOp
) {}
169 virtual bool paste (ARDOUR::framepos_t
, float /*times*/, Selection
&, size_t /*nth*/) { return false; }
171 virtual void set_selected_regionviews (RegionSelection
&) {}
172 virtual void set_selected_points (PointSelection
&) {}
174 virtual boost::shared_ptr
<ARDOUR::Region
> find_next_region (framepos_t
/*pos*/, ARDOUR::RegionPoint
, int32_t /*dir*/) {
175 return boost::shared_ptr
<ARDOUR::Region
> ();
178 void order_selection_trims (ArdourCanvas::Item
*item
, bool put_start_on_top
);
180 virtual void get_selectables (ARDOUR::framepos_t
, ARDOUR::framepos_t
, double, double, std::list
<Selectable
*>&);
181 virtual void get_inverted_selectables (Selection
&, std::list
<Selectable
*>& results
);
183 void add_ghost (RegionView
*);
184 void remove_ghost (RegionView
*);
185 void erase_ghost (GhostRegion
*);
187 /** called at load time when first GUI idle occurs. put
188 expensive data loading/redisplay code in here. */
189 virtual void first_idle () {}
191 TimeAxisView
* get_parent () { return parent
; }
192 void set_parent (TimeAxisView
& p
);
194 virtual LayerDisplay
layer_display () const { return Overlaid
; }
195 virtual StreamView
* view () const { return 0; }
197 typedef std::vector
<boost::shared_ptr
<TimeAxisView
> > Children
;
198 Children
get_child_list ();
200 SelectionRect
* get_selection_rect(uint32_t id
);
202 static uint32_t preset_height (Height
);
205 /* The Standard LHS Controls */
206 Gtk::HBox controls_hbox
;
207 Gtk::Table controls_table
;
208 Gtk::EventBox controls_ebox
;
209 Gtk::VBox controls_vbox
;
210 Gtk::VBox time_axis_vbox
;
212 Gtk::Frame name_frame
;
213 Gtkmm2ext::FocusEntry name_entry
;
215 uint32_t height
; /* in canvas units */
217 std::string controls_base_unselected_name
;
218 std::string controls_base_selected_name
;
220 bool name_entry_button_press (GdkEventButton
*ev
);
221 bool name_entry_button_release (GdkEventButton
*ev
);
222 bool name_entry_key_release (GdkEventKey
*ev
);
223 void name_entry_activated ();
224 sigc::connection name_entry_key_timeout
;
225 bool name_entry_key_timed_out ();
226 guint32 last_name_entry_key_press_event
;
228 /* derived classes can override these */
230 virtual void name_entry_changed ();
231 virtual bool name_entry_focus_in (GdkEventFocus
*ev
);
232 virtual bool name_entry_focus_out (GdkEventFocus
*ev
);
234 /** Handle mouse relaese on our LHS control name ebox.
236 *@ param ev the event
238 virtual bool controls_ebox_button_release (GdkEventButton
*);
239 virtual bool controls_ebox_scroll (GdkEventScroll
*);
240 virtual bool controls_ebox_button_press (GdkEventButton
*);
241 virtual bool controls_ebox_motion (GdkEventMotion
*);
242 virtual bool controls_ebox_leave (GdkEventCrossing
*);
244 /** Display the standard LHS control menu at when.
246 * @param when the popup activation time
248 virtual void popup_display_menu (guint32 when
);
250 /** Build the standard LHS control menu.
251 * Subclasses should extend this method to add their own menu options.
253 virtual void build_display_menu ();
255 /** Do whatever needs to be done to dynamically reset the LHS control menu.
257 virtual bool handle_display_menu_map_event (GdkEventAny
* /*ev*/) { return false; }
259 /* The standard LHS Track control popup-menus */
261 Gtk::Menu
*display_menu
;
263 Gtk::Label name_label
;
265 TimeAxisView
* parent
;
268 bool is_child (TimeAxisView
*);
270 void remove_child (boost::shared_ptr
<TimeAxisView
>);
271 void add_child (boost::shared_ptr
<TimeAxisView
>);
273 /* selection display */
275 ArdourCanvas::Group
*selection_group
;
277 std::list
<GhostRegion
*> ghosts
;
279 std::list
<SelectionRect
*> free_selection_rects
;
280 std::list
<SelectionRect
*> used_selection_rects
;
282 virtual void selection_click (GdkEventButton
*);
287 NamePackingBits name_packing
;
289 void set_heights (uint32_t h
);
290 void color_handler ();
292 void conditionally_add_to_selection ();
294 void build_size_menu ();
295 Gtk::Menu
* _size_menu
;
297 ArdourCanvas::Group
* _canvas_display
;
299 PublicEditor
& _editor
;
303 ArdourCanvas::Group
* _canvas_background
;
304 Gtk::VBox
* control_parent
;
306 uint32_t _effective_height
;
307 double _resize_drag_start
;
308 GdkCursor
* _preresize_cursor
;
309 bool _have_preresize_cursor
;
310 ArdourCanvas::Group
* _ghost_group
;
312 void compute_heights ();
313 static uint32_t extra_height
;
314 static uint32_t small_height
;
316 static int const _max_order
;
318 bool maybe_set_cursor (int y
);
320 }; /* class TimeAxisView */
322 #endif /* __ardour_gtk_time_axis_h__ */