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.
21 #ifndef __ardour_gtk_time_axis_h__
22 #define __ardour_gtk_time_axis_h__
27 #include <gtkmm/box.h>
28 #include <gtkmm/frame.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/table.h>
31 #include <gtkmm/entry.h>
32 #include <gtkmm/label.h>
34 #include <ardour/types.h>
35 #include <ardour/region.h>
38 #include "axis_view.h"
56 class AudioRegionSelection;
59 class TimeAxisViewItem;
64 * TimeAxisView defines the abstract base class for time-axis views.
66 * This class provides the basic LHS controls and display methods. This should be
67 * 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 Gtk::Entry name_entry;
124 void hide_name_label ();
125 void hide_name_entry ();
126 void show_name_label ();
127 void show_name_entry ();
130 * Display this TrackView as the nth component of the parent box, at y.
134 * @param parent the parent component
135 * @return the height of this TrackView
137 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
139 bool touched (double top, double bot);
142 * Hides this TrackView
144 virtual void hide ();
145 bool hidden() const { return _hidden; }
147 virtual void set_selected (bool);
150 * potential handler for entered events
153 virtual void entered () {}
154 virtual void exited () {}
156 virtual void set_height (TrackHeight h);
160 * Steps through the defined heights for this TrackView.
161 * Sets bigger to true to step up in size, set to fals eot step smaller.
163 * @param bigger true if stepping should increase in size, false otherwise
165 virtual void step_height (bool bigger);
167 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
168 virtual ARDOUR::Playlist* playlist() const { return 0; }
170 virtual void set_samples_per_unit (double);
171 virtual void show_selection (TimeSelection&);
172 virtual void hide_selection ();
173 virtual void reshow_selection (TimeSelection&);
174 virtual void show_timestretch (jack_nframes_t start, jack_nframes_t end);
175 virtual void hide_timestretch ();
177 virtual void hide_dependent_views (TimeAxisViewItem&) {}
178 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
180 /* editing operations */
182 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
183 virtual bool paste (jack_nframes_t, float times, Selection&, size_t nth) { return false; }
185 virtual void set_selected_regionviews (AudioRegionSelection&) {}
186 virtual void set_selected_points (PointSelection&) {}
188 virtual ARDOUR::Region* find_next_region (jack_nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
192 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
194 virtual void get_selectables (jack_nframes_t start, jack_nframes_t end, double top, double bot, list<Selectable*>& results);
195 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
197 /* state/serialization management */
199 void set_parent (TimeAxisView& p);
200 bool has_state () const;
202 virtual void set_state (const XMLNode&);
203 virtual XMLNode* get_state_node () { return 0; }
205 /* call this on the parent */
207 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
211 string controls_base_unselected_name;
212 string controls_base_selected_name;
214 bool name_entry_button_press (GdkEventButton *ev);
215 bool name_entry_button_release (GdkEventButton *ev);
216 bool name_entry_key_release (GdkEventKey *ev);
217 void name_entry_activated ();
218 sigc::connection name_entry_key_timeout;
219 bool name_entry_key_timed_out ();
220 guint32 last_name_entry_key_press_event;
222 /* derived classes can override these */
224 virtual void name_entry_changed ();
225 virtual bool name_entry_focus_in (GdkEventFocus *ev);
226 virtual bool name_entry_focus_out (GdkEventFocus *ev);
229 * Handle mouse relaese on our LHS control name ebox.
231 *@ param ev the event
233 virtual bool controls_ebox_button_release (GdkEventButton *ev);
234 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
237 * Displays the standard LHS control menu at when.
239 * @param when the popup activation time
241 virtual void popup_display_menu (guint32 when);
244 * Build the standard LHS control menu.
245 * Subclasses should extend this method to add their own menu options.
248 virtual void build_display_menu ();
251 * Do anything that needs to be done to dynamically reset
252 * the LHS control menu.
254 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
257 * Build the standard LHS control size menu for the default heights options.
260 virtual void build_size_menu();
263 * Displays the standard LHS controls size menu for the track heights
265 * @parem when the popup activation time
267 void popup_size_menu(guint32 when);
270 * Handle the size option of out main menu.
272 * @param ev the event
274 gint size_click(GdkEventButton *ev);
276 /* The standard LHS Track control popup-menus */
278 Gtk::Menu *display_menu;
279 Gtk::Menu *size_menu;
281 Gtk::Label name_label;
283 TimeAxisView* parent;
285 /* find the parent with state */
287 TimeAxisView* get_parent_with_state();
289 std::vector<TimeAxisView*> children;
290 bool is_child (TimeAxisView*);
292 void remove_child (TimeAxisView*);
293 void add_child (TimeAxisView*);
295 /* selection display */
297 ArdourCanvas::Group *selection_group;
299 list<SelectionRect*> free_selection_rects;
300 list<SelectionRect*> used_selection_rects;
302 SelectionRect* get_selection_rect(uint32_t id);
304 virtual void selection_click (GdkEventButton*);
308 NamePackingBits name_packing;
310 static void compute_controls_size_info ();
311 static bool need_size_info;
313 void set_height_pixels (uint32_t h);
315 }; /* class TimeAxisView */
317 #endif /* __ardour_gtk_time_axis_h__ */