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 */
100 double height_scaling_factor; /* used to zoom the track height without changing it */
104 uint32_t current_height() const { return (uint32_t) floor (height * height_scaling_factor); }
105 void set_height_scaling_factor (double);
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::EventBox 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 int32_t resize_idle_id;
133 void hide_name_label ();
134 void hide_name_entry ();
135 void show_name_label ();
136 void show_name_entry ();
139 * Display this TrackView as the nth component of the parent box, at y.
143 * @param parent the parent component
144 * @return the height of this TrackView
146 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
148 bool touched (double top, double bot);
151 * Hides this TrackView
153 virtual void hide ();
154 bool hidden() const { return _hidden; }
156 virtual void set_selected (bool);
159 * potential handler for entered events
162 virtual void entered () {}
163 virtual void exited () {}
165 virtual void set_height (uint32_t h);
169 * Returns a TimeAxisView* if this object covers y, or one of its children does.
170 * If the covering object is a child axis, then the child is returned.
171 * Returns 0 otherwise.
174 TimeAxisView* covers_y_position (double y);
177 * Steps through the defined heights for this TrackView.
178 * Sets bigger to true to step up in size, set to fals eot step smaller.
180 * @param bigger true if stepping should increase in size, false otherwise
182 virtual void step_height (bool bigger);
184 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
185 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
187 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
188 virtual void hide_feature_lines ();
190 virtual void set_samples_per_unit (double);
191 virtual void show_selection (TimeSelection&);
192 virtual void hide_selection ();
193 virtual void reshow_selection (TimeSelection&);
194 virtual void show_timestretch (nframes_t start, nframes_t end);
195 virtual void hide_timestretch ();
197 virtual void hide_dependent_views (TimeAxisViewItem&) {}
198 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
200 /* editing operations */
202 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
203 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
205 virtual void set_selected_regionviews (RegionSelection&) {}
206 virtual void set_selected_points (PointSelection&) {}
208 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
209 return boost::shared_ptr<ARDOUR::Region> ();
212 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
214 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
215 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
217 /* called at load time when first GUI idle occurs. put
218 expensive data loading/redisplay code in here.
221 virtual void first_idle () {}
223 /* state/serialization management */
225 void set_parent (TimeAxisView& p);
226 bool has_state () const;
228 /* call this on the parent */
230 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
233 uint32_t height; /* in canvas units */
235 string controls_base_unselected_name;
236 string controls_base_selected_name;
238 bool name_entry_button_press (GdkEventButton *ev);
239 bool name_entry_button_release (GdkEventButton *ev);
240 bool name_entry_key_release (GdkEventKey *ev);
241 void name_entry_activated ();
242 sigc::connection name_entry_key_timeout;
243 bool name_entry_key_timed_out ();
244 guint32 last_name_entry_key_press_event;
246 /* derived classes can override these */
248 virtual void name_entry_changed ();
249 virtual bool name_entry_focus_in (GdkEventFocus *ev);
250 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);
261 * Displays the standard LHS control menu at when.
263 * @param when the popup activation time
265 virtual void popup_display_menu (guint32 when);
268 * Build the standard LHS control menu.
269 * Subclasses should extend this method to add their own menu options.
272 virtual void build_display_menu ();
275 * Do anything that needs to be done to dynamically reset
276 * the LHS control menu.
278 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
281 * Build the standard LHS control size menu for the default heights options.
284 virtual void build_size_menu();
287 * Displays the standard LHS controls size menu for the track heights
289 * @parem when the popup activation time
291 void popup_size_menu(guint32 when);
294 * Handle the size option of out main menu.
296 * @param ev the event
298 gint size_click(GdkEventButton *ev);
300 /* The standard LHS Track control popup-menus */
302 Gtk::Menu *display_menu;
303 Gtk::Menu *size_menu;
305 Gtk::Label name_label;
307 TimeAxisView* parent;
309 /* find the parent with state */
311 TimeAxisView* get_parent_with_state();
313 std::vector<TimeAxisView*> children;
314 bool is_child (TimeAxisView*);
316 void remove_child (TimeAxisView*);
317 void add_child (TimeAxisView*);
319 /* selection display */
321 ArdourCanvas::Group *selection_group;
323 list<SelectionRect*> free_selection_rects;
324 list<SelectionRect*> used_selection_rects;
326 SelectionRect* get_selection_rect(uint32_t id);
328 virtual void selection_click (GdkEventButton*);
332 NamePackingBits name_packing;
334 static void compute_controls_size_info ();
335 static bool need_size_info;
337 void set_heights (uint32_t h);
338 void color_handler ();
340 list<ArdourCanvas::SimpleLine*> feature_lines;
341 ARDOUR::AnalysisFeatureList analysis_features;
342 void reshow_feature_lines ();
344 void conditionally_add_to_selection ();
346 }; /* class TimeAxisView */
348 #endif /* __ardour_gtk_time_axis_h__ */