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/eventbox.h>
29 #include <gtkmm/table.h>
30 #include <gtkmm/entry.h>
31 #include <gtkmm/label.h>
33 #include <gtkmm2ext/focus_entry.h>
35 #include <ardour/types.h>
36 #include <ardour/region.h>
37 #include <ardour/parameter.h>
40 #include "axis_view.h"
58 class RegionSelection;
61 class TimeAxisViewItem;
65 /** Abstract base class for time-axis views (horizontal editor 'strips')
67 * This class provides the basic LHS controls and display methods. This should be
68 * extended to create functional time-axis based views.
70 class TimeAxisView : public virtual AxisView
73 enum NamePackingBits {
74 NameLabelPacked = 0x1,
88 static uint32_t hLargest;
89 static uint32_t hLarge;
90 static uint32_t hLarger;
91 static uint32_t hNormal;
92 static uint32_t hSmaller;
93 static uint32_t hSmall;
95 static uint32_t height_to_pixels (TrackHeight);
97 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
98 virtual ~TimeAxisView ();
100 /* public data: XXX create accessor/mutators for these ?? */
102 PublicEditor& editor;
104 TrackHeight height_style;
105 uint32_t height; /* in canvas units */
106 uint32_t effective_height; /* in canvas units */
110 ArdourCanvas::Group *canvas_display;
111 Gtk::VBox *control_parent;
113 /* The Standard LHS Controls */
114 Gtk::Frame controls_frame;
115 Gtk::HBox controls_hbox;
116 Gtk::EventBox controls_lhs_pad;
117 Gtk::Table controls_table;
118 Gtk::EventBox controls_ebox;
119 Gtk::VBox controls_vbox;
121 Gtk::Frame name_frame;
122 Gtkmm2ext::FocusEntry name_entry;
124 void hide_name_label ();
125 void hide_name_entry ();
126 void show_name_label ();
127 void show_name_entry ();
129 /** Display this TrackView as the nth component of the parent box, at y.
133 * @param parent the parent component
134 * @return the height of this TrackView
136 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
138 bool touched (double top, double bot);
140 /** Hides this TrackView */
141 virtual void hide ();
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 (TrackHeight h);
157 * Returns a TimeAxisView* if this object covers y, or one of its children does.
158 * If the covering object is a child axis, then the child is returned.
159 * Returns 0 otherwise.
162 TimeAxisView* covers_y_position (double y);
165 * Steps through the defined heights for this TrackView.
166 * Sets bigger to true to step up in size, set to fals eot step smaller.
168 * @param bigger true if stepping should increase in size, false otherwise
170 virtual void step_height (bool bigger);
172 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
173 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
175 virtual void set_samples_per_unit (double);
176 virtual void show_selection (TimeSelection&);
177 virtual void hide_selection ();
178 virtual void reshow_selection (TimeSelection&);
179 virtual void show_timestretch (nframes_t start, nframes_t end);
180 virtual void hide_timestretch ();
182 virtual void hide_dependent_views (TimeAxisViewItem&) {}
183 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
185 /* editing operations */
187 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
188 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
190 virtual void set_selected_regionviews (RegionSelection&) {}
191 virtual void set_selected_points (PointSelection&) {}
193 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
194 return boost::shared_ptr<ARDOUR::Region> ();
197 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
199 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
200 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
202 /* state/serialization management */
204 TimeAxisView* get_parent () { return parent; }
205 void set_parent (TimeAxisView& p);
206 bool has_state () const;
208 virtual void set_state (const XMLNode&);
209 virtual XMLNode* get_state_node () { return 0; }
211 /* call this on the parent */
213 virtual XMLNode* get_automation_child_xml_node (ARDOUR::Parameter param) { return 0; }
215 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
219 string controls_base_unselected_name;
220 string controls_base_selected_name;
222 bool name_entry_button_press (GdkEventButton *ev);
223 bool name_entry_button_release (GdkEventButton *ev);
224 bool name_entry_key_release (GdkEventKey *ev);
225 void name_entry_activated ();
226 sigc::connection name_entry_key_timeout;
227 bool name_entry_key_timed_out ();
228 guint32 last_name_entry_key_press_event;
230 /* derived classes can override these */
232 virtual void name_entry_changed ();
233 virtual bool name_entry_focus_in (GdkEventFocus *ev);
234 virtual bool name_entry_focus_out (GdkEventFocus *ev);
236 /** Handle mouse relaese on our LHS control name ebox.
238 *@ param ev the event
240 virtual bool controls_ebox_button_release (GdkEventButton *ev);
241 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
243 /** Display the standard LHS control menu at when.
245 * @param when the popup activation time
247 virtual void popup_display_menu (guint32 when);
249 /** Build the standard LHS control menu.
250 * Subclasses should extend this method to add their own menu options.
252 virtual void build_display_menu ();
254 /** Do whatever needs to be done to dynamically reset the LHS control menu.
256 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
258 /** Build the standard LHS control size menu for the default heights options.
260 virtual void build_size_menu();
262 /** Displays the standard LHS controls size menu for the track heights
264 * @param when the popup activation time
266 void popup_size_menu(guint32 when);
268 /** Handle the size option of our main menu.
270 * @param ev the event
272 gint size_click(GdkEventButton *ev);
274 /* The standard LHS Track control popup-menus */
276 Gtk::Menu *display_menu;
277 Gtk::Menu *size_menu;
279 Gtk::Label name_label;
281 TimeAxisView* parent;
283 /** Find the parent with state */
284 TimeAxisView* get_parent_with_state();
287 bool is_child (TimeAxisView*);
289 void remove_child (boost::shared_ptr<TimeAxisView>);
290 void add_child (boost::shared_ptr<TimeAxisView>);
292 /* selection display */
294 ArdourCanvas::Group *selection_group;
296 list<SelectionRect*> free_selection_rects;
297 list<SelectionRect*> used_selection_rects;
299 SelectionRect* get_selection_rect(uint32_t id);
301 virtual void selection_click (GdkEventButton*);
305 NamePackingBits name_packing;
307 static void compute_controls_size_info ();
308 static bool need_size_info;
310 void set_height_pixels (uint32_t h);
311 void color_handler ();
313 }; /* class TimeAxisView */
315 #endif /* __ardour_gtk_time_axis_h__ */