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>
39 #include "axis_view.h"
57 class RegionSelection;
60 class TimeAxisViewItem;
65 * TimeAxisView defines the abstract base class for time-axis views.
67 * This class provides the basic LHS controls and display methods. This should be
68 * extended to create functional time-axis based views.
71 class TimeAxisView : public virtual AxisView
74 enum NamePackingBits {
75 NameLabelPacked = 0x1,
89 static uint32_t hLargest;
90 static uint32_t hLarge;
91 static uint32_t hLarger;
92 static uint32_t hNormal;
93 static uint32_t hSmaller;
94 static uint32_t hSmall;
96 static uint32_t height_to_pixels (TrackHeight);
98 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
99 virtual ~TimeAxisView ();
101 /* public data: XXX create accessor/mutators for these ?? */
103 PublicEditor& editor;
105 TrackHeight height_style;
106 uint32_t height; /* in canvas units */
107 uint32_t effective_height; /* in canvas units */
111 ArdourCanvas::Group *canvas_display;
112 Gtk::VBox *control_parent;
114 /* The Standard LHS Controls */
115 Gtk::Frame controls_frame;
116 Gtk::HBox controls_hbox;
117 Gtk::EventBox controls_lhs_pad;
118 Gtk::Table controls_table;
119 Gtk::EventBox controls_ebox;
120 Gtk::VBox controls_vbox;
122 Gtk::Frame name_frame;
123 Gtkmm2ext::FocusEntry name_entry;
125 void hide_name_label ();
126 void hide_name_entry ();
127 void show_name_label ();
128 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);
143 * Hides this TrackView
145 virtual void hide ();
146 bool hidden() const { return _hidden; }
148 virtual void set_selected (bool);
151 * potential handler for entered events
154 virtual void entered () {}
155 virtual void exited () {}
157 virtual void set_height (TrackHeight h);
161 * Returns a TimeAxisView* if this object covers y, or one of its children does.
162 * If the covering object is a child axis, then the child is returned.
163 * Returns 0 otherwise.
166 TimeAxisView* covers_y_position (double y);
169 * Steps through the defined heights for this TrackView.
170 * Sets bigger to true to step up in size, set to fals eot step smaller.
172 * @param bigger true if stepping should increase in size, false otherwise
174 virtual void step_height (bool bigger);
176 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
177 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
179 virtual void show_temporary_lines (const ARDOUR::AnalysisFeatureList&);
180 virtual void hide_temporary_lines ();
182 virtual void set_samples_per_unit (double);
183 virtual void show_selection (TimeSelection&);
184 virtual void hide_selection ();
185 virtual void reshow_selection (TimeSelection&);
186 virtual void show_timestretch (nframes_t start, nframes_t end);
187 virtual void hide_timestretch ();
189 virtual void hide_dependent_views (TimeAxisViewItem&) {}
190 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
192 /* editing operations */
194 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
195 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
197 virtual void set_selected_regionviews (RegionSelection&) {}
198 virtual void set_selected_points (PointSelection&) {}
200 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
201 return boost::shared_ptr<ARDOUR::Region> ();
204 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
206 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
207 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
209 /* state/serialization management */
211 void set_parent (TimeAxisView& p);
212 bool has_state () const;
214 virtual void set_state (const XMLNode&);
215 virtual XMLNode* get_state_node () { return 0; }
217 /* call this on the parent */
219 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
223 string controls_base_unselected_name;
224 string controls_base_selected_name;
226 bool name_entry_button_press (GdkEventButton *ev);
227 bool name_entry_button_release (GdkEventButton *ev);
228 bool name_entry_key_release (GdkEventKey *ev);
229 void name_entry_activated ();
230 sigc::connection name_entry_key_timeout;
231 bool name_entry_key_timed_out ();
232 guint32 last_name_entry_key_press_event;
234 /* derived classes can override these */
236 virtual void name_entry_changed ();
237 virtual bool name_entry_focus_in (GdkEventFocus *ev);
238 virtual bool name_entry_focus_out (GdkEventFocus *ev);
241 * Handle mouse relaese on our LHS control name ebox.
243 *@ param ev the event
245 virtual bool controls_ebox_button_release (GdkEventButton *ev);
246 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
249 * Displays the standard LHS control menu at when.
251 * @param when the popup activation time
253 virtual void popup_display_menu (guint32 when);
256 * Build the standard LHS control menu.
257 * Subclasses should extend this method to add their own menu options.
260 virtual void build_display_menu ();
263 * Do anything that needs to be done to dynamically reset
264 * the LHS control menu.
266 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
269 * Build the standard LHS control size menu for the default heights options.
272 virtual void build_size_menu();
275 * Displays the standard LHS controls size menu for the track heights
277 * @parem when the popup activation time
279 void popup_size_menu(guint32 when);
282 * Handle the size option of out main menu.
284 * @param ev the event
286 gint size_click(GdkEventButton *ev);
288 /* The standard LHS Track control popup-menus */
290 Gtk::Menu *display_menu;
291 Gtk::Menu *size_menu;
293 Gtk::Label name_label;
295 TimeAxisView* parent;
297 /* find the parent with state */
299 TimeAxisView* get_parent_with_state();
301 std::vector<TimeAxisView*> children;
302 bool is_child (TimeAxisView*);
304 void remove_child (TimeAxisView*);
305 void add_child (TimeAxisView*);
307 /* selection display */
309 ArdourCanvas::Group *selection_group;
311 list<SelectionRect*> free_selection_rects;
312 list<SelectionRect*> used_selection_rects;
314 SelectionRect* get_selection_rect(uint32_t id);
316 virtual void selection_click (GdkEventButton*);
320 NamePackingBits name_packing;
322 static void compute_controls_size_info ();
323 static bool need_size_info;
325 void set_heights (TrackHeight);
326 void set_height_pixels (uint32_t h);
327 void color_handler ();
329 list<ArdourCanvas::SimpleLine*> temp_lines;
331 }; /* class TimeAxisView */
333 #endif /* __ardour_gtk_time_axis_h__ */