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 <pbd/stateful.h>
37 #include <ardour/types.h>
38 #include <ardour/region.h>
41 #include "axis_view.h"
59 class RegionSelection;
62 class TimeAxisViewItem;
67 * TimeAxisView defines the abstract base class for time-axis views.
69 * This class provides the basic LHS controls and display methods. This should be
70 * extended to create functional time-axis based views.
73 class TimeAxisView : public virtual AxisView, public Stateful
76 enum NamePackingBits {
77 NameLabelPacked = 0x1,
82 static uint32_t hLargest;
83 static uint32_t hLarge;
84 static uint32_t hLarger;
85 static uint32_t hNormal;
86 static uint32_t hSmaller;
87 static uint32_t hSmall;
89 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
90 virtual ~TimeAxisView ();
92 XMLNode& get_state (void);
93 int set_state (const XMLNode&);
95 /* public data: XXX create accessor/mutators for these ?? */
99 uint32_t effective_height; /* in canvas units */
103 uint32_t current_height() const { return height; }
105 ArdourCanvas::Group *canvas_display;
106 Gtk::VBox *control_parent;
108 /* The Standard LHS Controls */
109 Gtk::Frame controls_frame;
110 Gtk::HBox controls_hbox;
111 Gtk::EventBox controls_lhs_pad;
112 Gtk::Table controls_table;
113 Gtk::EventBox controls_ebox;
114 Gtk::VBox controls_vbox;
115 Gtk::EventBox resizer;
116 Gtk::HBox resizer_box;
118 Gtk::Frame name_frame;
119 Gtkmm2ext::FocusEntry name_entry;
121 bool resizer_button_press (GdkEventButton*);
122 bool resizer_button_release (GdkEventButton*);
123 bool resizer_motion (GdkEventMotion*);
124 bool resizer_expose (GdkEventExpose*);
126 double resize_drag_start;
127 int32_t resize_idle_target;
128 int32_t resize_idle_id;
131 void hide_name_label ();
132 void hide_name_entry ();
133 void show_name_label ();
134 void show_name_entry ();
137 * Display this TrackView as the nth component of the parent box, at y.
141 * @param parent the parent component
142 * @return the height of this TrackView
144 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
146 bool touched (double top, double bot);
149 * Hides this TrackView
151 virtual void hide ();
152 bool hidden() const { return _hidden; }
154 virtual void set_selected (bool);
157 * potential handler for entered events
160 virtual void entered () {}
161 virtual void exited () {}
163 virtual void set_height (uint32_t h);
167 * Returns a TimeAxisView* if this object covers y, or one of its children does.
168 * If the covering object is a child axis, then the child is returned.
169 * Returns 0 otherwise.
172 TimeAxisView* covers_y_position (double y);
175 * Steps through the defined heights for this TrackView.
176 * Sets bigger to true to step up in size, set to fals eot step smaller.
178 * @param bigger true if stepping should increase in size, false otherwise
180 virtual void step_height (bool bigger);
182 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
183 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
185 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
186 virtual void hide_feature_lines ();
188 virtual void set_samples_per_unit (double);
189 virtual void show_selection (TimeSelection&);
190 virtual void hide_selection ();
191 virtual void reshow_selection (TimeSelection&);
192 virtual void show_timestretch (nframes_t start, nframes_t end);
193 virtual void hide_timestretch ();
195 virtual void hide_dependent_views (TimeAxisViewItem&) {}
196 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
198 /* editing operations */
200 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
201 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
203 virtual void set_selected_regionviews (RegionSelection&) {}
204 virtual void set_selected_points (PointSelection&) {}
206 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
207 return boost::shared_ptr<ARDOUR::Region> ();
210 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
212 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
213 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
215 /* called at load time when first GUI idle occurs. put
216 expensive data loading/redisplay code in here.
219 virtual void first_idle () {}
221 /* state/serialization management */
223 void set_parent (TimeAxisView& p);
224 bool has_state () const;
226 /* call this on the parent */
228 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
231 uint32_t height; /* in canvas units */
233 string controls_base_unselected_name;
234 string controls_base_selected_name;
236 bool name_entry_button_press (GdkEventButton *ev);
237 bool name_entry_button_release (GdkEventButton *ev);
238 bool name_entry_key_release (GdkEventKey *ev);
239 void name_entry_activated ();
240 sigc::connection name_entry_key_timeout;
241 bool name_entry_key_timed_out ();
242 guint32 last_name_entry_key_press_event;
244 /* derived classes can override these */
246 virtual void name_entry_changed ();
247 virtual bool name_entry_focus_in (GdkEventFocus *ev);
248 virtual bool name_entry_focus_out (GdkEventFocus *ev);
251 * Handle mouse relaese on our LHS control name ebox.
253 *@ param ev the event
255 virtual bool controls_ebox_button_release (GdkEventButton *ev);
256 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
259 * Displays the standard LHS control menu at when.
261 * @param when the popup activation time
263 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.
270 virtual void build_display_menu ();
273 * Do anything that needs to be done to dynamically reset
274 * the LHS control menu.
276 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
279 * Build the standard LHS control size menu for the default heights options.
282 virtual void build_size_menu();
285 * Displays the standard LHS controls size menu for the track heights
287 * @parem when the popup activation time
289 void popup_size_menu(guint32 when);
292 * Handle the size option of out main menu.
294 * @param ev the event
296 gint size_click(GdkEventButton *ev);
298 /* The standard LHS Track control popup-menus */
300 Gtk::Menu *display_menu;
301 Gtk::Menu *size_menu;
303 Gtk::Label name_label;
305 TimeAxisView* parent;
307 /* find the parent with state */
309 TimeAxisView* get_parent_with_state();
311 std::vector<TimeAxisView*> children;
312 bool is_child (TimeAxisView*);
314 void remove_child (TimeAxisView*);
315 void add_child (TimeAxisView*);
317 /* selection display */
319 ArdourCanvas::Group *selection_group;
321 list<SelectionRect*> free_selection_rects;
322 list<SelectionRect*> used_selection_rects;
324 SelectionRect* get_selection_rect(uint32_t id);
326 virtual void selection_click (GdkEventButton*);
330 NamePackingBits name_packing;
332 static void compute_controls_size_info ();
333 static bool need_size_info;
335 void set_heights (uint32_t h);
336 void color_handler ();
338 list<ArdourCanvas::SimpleLine*> feature_lines;
339 ARDOUR::AnalysisFeatureList analysis_features;
340 void reshow_feature_lines ();
342 void conditionally_add_to_selection ();
344 }; /* class TimeAxisView */
346 #endif /* __ardour_gtk_time_axis_h__ */