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;
67 /** Abstract base class for time-axis views (horizontal editor 'strips')
69 * This class provides the basic LHS controls and display methods. This should be
70 * extended to create functional time-axis based views.
72 class TimeAxisView : public virtual AxisView
75 enum NamePackingBits {
76 NameLabelPacked = 0x1,
90 static uint32_t hLargest;
91 static uint32_t hLarge;
92 static uint32_t hLarger;
93 static uint32_t hNormal;
94 static uint32_t hSmaller;
95 static uint32_t hSmall;
97 static uint32_t height_to_pixels (TrackHeight);
99 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
100 virtual ~TimeAxisView ();
102 /* public data: XXX create accessor/mutators for these ?? */
104 PublicEditor& editor;
106 TrackHeight height_style;
107 uint32_t height; /* in canvas units */
108 uint32_t effective_height; /* in canvas units */
112 ArdourCanvas::Group *canvas_display;
113 Gtk::VBox *control_parent;
115 /* The Standard LHS Controls */
116 Gtk::Frame controls_frame;
117 Gtk::HBox controls_hbox;
118 Gtk::EventBox controls_lhs_pad;
119 Gtk::Table controls_table;
120 Gtk::EventBox controls_ebox;
121 Gtk::VBox controls_vbox;
123 Gtk::Frame name_frame;
124 Gtkmm2ext::FocusEntry name_entry;
126 void hide_name_label ();
127 void hide_name_entry ();
128 void show_name_label ();
129 void show_name_entry ();
131 /** Display this TrackView as the nth component of the parent box, at y.
135 * @param parent the parent component
136 * @return the height of this TrackView
138 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
140 bool touched (double top, double bot);
142 /** Hides this TrackView */
143 virtual void hide ();
144 bool hidden() const { return _hidden; }
146 virtual void set_selected (bool);
149 * potential handler for entered events
152 virtual void entered () {}
153 virtual void exited () {}
155 virtual void set_height (TrackHeight h);
159 * Returns a TimeAxisView* if this object covers y, or one of its children does.
160 * If the covering object is a child axis, then the child is returned.
161 * Returns 0 otherwise.
164 TimeAxisView* covers_y_position (double y);
167 * Steps through the defined heights for this TrackView.
168 * Sets bigger to true to step up in size, set to fals eot step smaller.
170 * @param bigger true if stepping should increase in size, false otherwise
172 virtual void step_height (bool bigger);
174 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
175 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
177 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
178 virtual void hide_feature_lines ();
180 virtual void set_samples_per_unit (double);
181 virtual void show_selection (TimeSelection&);
182 virtual void hide_selection ();
183 virtual void reshow_selection (TimeSelection&);
184 virtual void show_timestretch (nframes_t start, nframes_t end);
185 virtual void hide_timestretch ();
187 virtual void hide_dependent_views (TimeAxisViewItem&) {}
188 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
190 /* editing operations */
192 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
193 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
195 virtual void set_selected_regionviews (RegionSelection&) {}
196 virtual void set_selected_points (PointSelection&) {}
198 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
199 return boost::shared_ptr<ARDOUR::Region> ();
202 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
204 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
205 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
207 ArdourCanvas::Group* ghost_group;
209 void add_ghost (RegionView*);
210 void remove_ghost (RegionView*);
211 void erase_ghost (GhostRegion*);
213 /* called at load time when first GUI idle occurs. put
214 expensive data loading/redisplay code in here.
217 virtual void first_idle () {}
219 /* state/serialization management */
221 TimeAxisView* get_parent () { return parent; }
222 void set_parent (TimeAxisView& p);
223 bool has_state () const;
225 virtual void set_state (const XMLNode&);
226 virtual XMLNode* get_state_node () { return 0; }
228 /* call this on the parent */
230 virtual XMLNode* get_automation_child_xml_node (ARDOUR::Parameter param) { return 0; }
232 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
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);
253 /** Handle mouse relaese on our LHS control name ebox.
255 *@ param ev the event
257 virtual bool controls_ebox_button_release (GdkEventButton *ev);
258 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
260 /** Display the standard LHS control menu at when.
262 * @param when the popup activation time
264 virtual void popup_display_menu (guint32 when);
266 /** Build the standard LHS control menu.
267 * Subclasses should extend this method to add their own menu options.
269 virtual void build_display_menu ();
271 /** Do whatever needs to be done to dynamically reset the LHS control menu.
273 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
275 /** Build the standard LHS control size menu for the default heights options.
277 virtual void build_size_menu();
279 /** Displays the standard LHS controls size menu for the track heights
281 * @param when the popup activation time
283 void popup_size_menu(guint32 when);
285 /** Handle the size option of our main menu.
287 * @param ev the event
289 gint size_click(GdkEventButton *ev);
291 /* The standard LHS Track control popup-menus */
293 Gtk::Menu *display_menu;
294 Gtk::Menu *size_menu;
296 Gtk::Label name_label;
298 TimeAxisView* parent;
300 /** Find the parent with state */
301 TimeAxisView* get_parent_with_state();
304 bool is_child (TimeAxisView*);
306 void remove_child (boost::shared_ptr<TimeAxisView>);
307 void add_child (boost::shared_ptr<TimeAxisView>);
309 /* selection display */
311 ArdourCanvas::Group *selection_group;
313 list<GhostRegion*> ghosts;
315 list<SelectionRect*> free_selection_rects;
316 list<SelectionRect*> used_selection_rects;
318 SelectionRect* get_selection_rect(uint32_t id);
320 virtual void selection_click (GdkEventButton*);
325 NamePackingBits name_packing;
327 static void compute_controls_size_info ();
328 static bool need_size_info;
330 void set_heights (TrackHeight);
331 void set_height_pixels (uint32_t h);
332 void color_handler ();
333 list<ArdourCanvas::SimpleLine*> feature_lines;
334 ARDOUR::AnalysisFeatureList analysis_features;
335 void reshow_feature_lines ();
337 void conditionally_add_to_selection ();
339 }; /* class TimeAxisView */
341 #endif /* __ardour_gtk_time_axis_h__ */