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>
42 #include "axis_view.h"
60 class RegionSelection
;
63 class TimeAxisViewItem
;
68 * TimeAxisView defines the abstract base class for time-axis views.
70 * This class provides the basic LHS controls and display methods. This should be
71 * extended to create functional time-axis based views.
74 class TimeAxisView
: public virtual AxisView
, public Stateful
77 enum NamePackingBits
{
78 NameLabelPacked
= 0x1,
83 static uint32_t hLargest
;
84 static uint32_t hLarge
;
85 static uint32_t hLarger
;
86 static uint32_t hNormal
;
87 static uint32_t hSmaller
;
88 static uint32_t hSmall
;
90 TimeAxisView(ARDOUR::Session
& sess
, PublicEditor
& ed
, TimeAxisView
* parent
, ArdourCanvas::Canvas
& canvas
);
91 virtual ~TimeAxisView ();
93 XMLNode
& get_state (void);
94 int set_state (const XMLNode
&);
96 /* public data: XXX create accessor/mutators for these ?? */
100 uint32_t effective_height
; /* in canvas units */
104 uint32_t current_height() const { return height
; }
106 ArdourCanvas::Group
*canvas_background
;
107 ArdourCanvas::Group
*canvas_display
;
108 Gtk::VBox
*control_parent
;
110 /* The Standard LHS Controls */
111 Gtk::Frame controls_frame
;
112 Gtk::HBox controls_hbox
;
113 Gtk::EventBox controls_lhs_pad
;
114 Gtk::Table controls_table
;
115 Gtk::EventBox controls_ebox
;
116 Gtk::VBox controls_vbox
;
117 Gtk::DrawingArea resizer
;
118 Gtk::HBox resizer_box
;
120 Gtk::Frame name_frame
;
121 Gtkmm2ext::FocusEntry name_entry
;
123 bool resizer_button_press (GdkEventButton
*);
124 bool resizer_button_release (GdkEventButton
*);
125 bool resizer_motion (GdkEventMotion
*);
126 bool resizer_expose (GdkEventExpose
*);
128 double resize_drag_start
;
129 int32_t resize_idle_target
;
130 void idle_resize (uint32_t);
132 void hide_name_label ();
133 void hide_name_entry ();
134 void show_name_label ();
135 void show_name_entry ();
138 * Display this TrackView as the nth component of the parent box, at y.
142 * @param parent the parent component
143 * @return the height of this TrackView
145 virtual guint32
show_at (double y
, int& nth
, Gtk::VBox
*parent
);
147 void clip_to_viewport ();
149 bool touched (double top
, double bot
);
152 * Hides this TrackView
154 virtual void hide ();
155 bool hidden() const { return _hidden
; }
157 virtual void set_selected (bool);
160 * potential handler for entered events
163 virtual void entered () {}
164 virtual void exited () {}
166 virtual void set_height (uint32_t h
);
170 * Returns a TimeAxisView* if this object covers y, or one of its children does.
171 * If the covering object is a child axis, then the child is returned.
172 * Returns 0 otherwise.
175 TimeAxisView
* covers_y_position (double y
);
178 * Steps through the defined heights for this TrackView.
179 * Sets bigger to true to step up in size, set to fals eot step smaller.
181 * @param bigger true if stepping should increase in size, false otherwise
183 virtual void step_height (bool bigger
);
185 virtual ARDOUR::RouteGroup
* edit_group() const { return 0; }
186 virtual boost::shared_ptr
<ARDOUR::Playlist
> playlist() const { return boost::shared_ptr
<ARDOUR::Playlist
> (); }
188 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList
&);
189 virtual void hide_feature_lines ();
191 virtual void set_samples_per_unit (double);
192 virtual void show_selection (TimeSelection
&);
193 virtual void hide_selection ();
194 virtual void reshow_selection (TimeSelection
&);
195 virtual void show_timestretch (nframes_t start
, nframes_t end
);
196 virtual void hide_timestretch ();
198 virtual void hide_dependent_views (TimeAxisViewItem
&) {}
199 virtual void reveal_dependent_views (TimeAxisViewItem
&) {}
201 /* editing operations */
203 virtual bool cut_copy_clear (Selection
&, Editing::CutCopyOp
) { return false; }
204 virtual bool paste (nframes_t
, float times
, Selection
&, size_t nth
) { return false; }
206 virtual void set_selected_regionviews (RegionSelection
&) {}
207 virtual void set_selected_points (PointSelection
&) {}
209 virtual boost::shared_ptr
<ARDOUR::Region
> find_next_region (nframes_t pos
, ARDOUR::RegionPoint
, int32_t dir
) {
210 return boost::shared_ptr
<ARDOUR::Region
> ();
213 void order_selection_trims (ArdourCanvas::Item
*item
, bool put_start_on_top
);
215 virtual void get_selectables (nframes_t start
, nframes_t end
, double top
, double bot
, list
<Selectable
*>& results
);
216 virtual void get_inverted_selectables (Selection
&, list
<Selectable
*>& results
);
218 /* called at load time when first GUI idle occurs. put
219 expensive data loading/redisplay code in here.
222 virtual void first_idle () {}
224 /* state/serialization management */
226 void set_parent (TimeAxisView
& p
);
227 bool has_state () const;
229 /* call this on the parent */
231 virtual XMLNode
* get_child_xml_node (const string
& childname
) { return 0; }
234 uint32_t height
; /* in canvas units */
236 string controls_base_unselected_name
;
237 string controls_base_selected_name
;
239 bool name_entry_button_press (GdkEventButton
*ev
);
240 bool name_entry_button_release (GdkEventButton
*ev
);
241 bool name_entry_key_release (GdkEventKey
*ev
);
242 void name_entry_activated ();
243 sigc::connection name_entry_key_timeout
;
244 bool name_entry_key_timed_out ();
245 guint32 last_name_entry_key_press_event
;
247 /* derived classes can override these */
249 virtual void name_entry_changed ();
250 virtual bool name_entry_focus_in (GdkEventFocus
*ev
);
251 virtual bool name_entry_focus_out (GdkEventFocus
*ev
);
254 * Handle mouse relaese on our LHS control name ebox.
256 *@ param ev the event
258 virtual bool controls_ebox_button_release (GdkEventButton
*ev
);
259 virtual bool controls_ebox_scroll (GdkEventScroll
*ev
);
262 * Displays the standard LHS control menu at when.
264 * @param when the popup activation time
266 virtual void popup_display_menu (guint32 when
);
269 * Build the standard LHS control menu.
270 * Subclasses should extend this method to add their own menu options.
273 virtual void build_display_menu ();
276 * Do anything that needs to be done to dynamically reset
277 * the LHS control menu.
279 virtual bool handle_display_menu_map_event (GdkEventAny
*ev
) { return false; }
282 * Build the standard LHS control size menu for the default heights options.
285 virtual void build_size_menu();
288 * Displays the standard LHS controls size menu for the track heights
290 * @parem when the popup activation time
292 void popup_size_menu(guint32 when
);
295 * Handle the size option of out main menu.
297 * @param ev the event
299 gint
size_click(GdkEventButton
*ev
);
301 /* The standard LHS Track control popup-menus */
303 Gtk::Menu
*display_menu
;
304 Gtk::Menu
*size_menu
;
306 Gtk::Label name_label
;
308 TimeAxisView
* parent
;
310 /* find the parent with state */
312 TimeAxisView
* get_parent_with_state();
314 std::vector
<TimeAxisView
*> children
;
315 bool is_child (TimeAxisView
*);
317 void remove_child (TimeAxisView
*);
318 void add_child (TimeAxisView
*);
320 /* selection display */
322 ArdourCanvas::Group
*selection_group
;
324 list
<SelectionRect
*> free_selection_rects
;
325 list
<SelectionRect
*> used_selection_rects
;
327 SelectionRect
* get_selection_rect(uint32_t id
);
329 virtual void selection_click (GdkEventButton
*);
333 NamePackingBits name_packing
;
335 static void compute_controls_size_info ();
336 static bool need_size_info
;
338 void set_heights (uint32_t h
);
339 void color_handler ();
341 list
<ArdourCanvas::SimpleLine
*> feature_lines
;
342 ARDOUR::AnalysisFeatureList analysis_features
;
343 void reshow_feature_lines ();
345 void conditionally_add_to_selection ();
347 }; /* class TimeAxisView */
349 #endif /* __ardour_gtk_time_axis_h__ */