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 <gtkmm2ext/focus_entry.h>
36 #include <ardour/types.h>
37 #include <ardour/region.h>
40 #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
76 enum NamePackingBits {
77 NameLabelPacked = 0x1,
91 static uint32_t hLargest;
92 static uint32_t hLarge;
93 static uint32_t hLarger;
94 static uint32_t hNormal;
95 static uint32_t hSmaller;
96 static uint32_t hSmall;
98 static uint32_t height_to_pixels (TrackHeight);
100 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
101 virtual ~TimeAxisView ();
103 /* public data: XXX create accessor/mutators for these ?? */
105 PublicEditor& editor;
107 TrackHeight height_style;
108 uint32_t height; /* in canvas units */
109 uint32_t effective_height; /* in canvas units */
113 ArdourCanvas::Group *canvas_display;
114 Gtk::VBox *control_parent;
116 /* The Standard LHS Controls */
117 Gtk::Frame controls_frame;
118 Gtk::HBox controls_hbox;
119 Gtk::EventBox controls_lhs_pad;
120 Gtk::Table controls_table;
121 Gtk::EventBox controls_ebox;
122 Gtk::VBox controls_vbox;
124 Gtk::Frame name_frame;
125 Gtkmm2ext::FocusEntry name_entry;
127 void hide_name_label ();
128 void hide_name_entry ();
129 void show_name_label ();
130 void show_name_entry ();
133 * Display this TrackView as the nth component of the parent box, at y.
137 * @param parent the parent component
138 * @return the height of this TrackView
140 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
142 bool touched (double top, double bot);
145 * Hides this TrackView
147 virtual void hide ();
148 bool hidden() const { return _hidden; }
150 virtual void set_selected (bool);
153 * potential handler for entered events
156 virtual void entered () {}
157 virtual void exited () {}
159 virtual void set_height (TrackHeight h);
163 * Steps through the defined heights for this TrackView.
164 * Sets bigger to true to step up in size, set to fals eot step smaller.
166 * @param bigger true if stepping should increase in size, false otherwise
168 virtual void step_height (bool bigger);
170 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
171 virtual ARDOUR::Playlist* playlist() const { return 0; }
173 virtual void set_samples_per_unit (double);
174 virtual void show_selection (TimeSelection&);
175 virtual void hide_selection ();
176 virtual void reshow_selection (TimeSelection&);
177 virtual void show_timestretch (nframes_t start, nframes_t end);
178 virtual void hide_timestretch ();
180 virtual void hide_dependent_views (TimeAxisViewItem&) {}
181 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
183 /* editing operations */
185 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
186 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
188 virtual void set_selected_regionviews (RegionSelection&) {}
189 virtual void set_selected_points (PointSelection&) {}
191 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
192 return boost::shared_ptr<ARDOUR::Region> ();
195 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
197 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
198 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
200 /* state/serialization management */
202 void set_parent (TimeAxisView& p);
203 bool has_state () const;
205 virtual void set_state (const XMLNode&);
206 virtual XMLNode* get_state_node () { return 0; }
208 /* call this on the parent */
210 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
214 string controls_base_unselected_name;
215 string controls_base_selected_name;
217 bool name_entry_button_press (GdkEventButton *ev);
218 bool name_entry_button_release (GdkEventButton *ev);
219 bool name_entry_key_release (GdkEventKey *ev);
220 void name_entry_activated ();
221 sigc::connection name_entry_key_timeout;
222 bool name_entry_key_timed_out ();
223 guint32 last_name_entry_key_press_event;
225 /* derived classes can override these */
227 virtual void name_entry_changed ();
228 virtual bool name_entry_focus_in (GdkEventFocus *ev);
229 virtual bool name_entry_focus_out (GdkEventFocus *ev);
232 * Handle mouse relaese on our LHS control name ebox.
234 *@ param ev the event
236 virtual bool controls_ebox_button_release (GdkEventButton *ev);
237 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
240 * Displays the standard LHS control menu at when.
242 * @param when the popup activation time
244 virtual void popup_display_menu (guint32 when);
247 * Build the standard LHS control menu.
248 * Subclasses should extend this method to add their own menu options.
251 virtual void build_display_menu ();
254 * Do anything that needs to be done to dynamically reset
255 * the LHS control menu.
257 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
260 * Build the standard LHS control size menu for the default heights options.
263 virtual void build_size_menu();
266 * Displays the standard LHS controls size menu for the track heights
268 * @parem when the popup activation time
270 void popup_size_menu(guint32 when);
273 * Handle the size option of out main menu.
275 * @param ev the event
277 gint size_click(GdkEventButton *ev);
279 /* The standard LHS Track control popup-menus */
281 Gtk::Menu *display_menu;
282 Gtk::Menu *size_menu;
284 Gtk::Label name_label;
286 TimeAxisView* parent;
288 /* find the parent with state */
290 TimeAxisView* get_parent_with_state();
292 std::vector<TimeAxisView*> children;
293 bool is_child (TimeAxisView*);
295 void remove_child (TimeAxisView*);
296 void add_child (TimeAxisView*);
298 /* selection display */
300 ArdourCanvas::Group *selection_group;
302 list<SelectionRect*> free_selection_rects;
303 list<SelectionRect*> used_selection_rects;
305 SelectionRect* get_selection_rect(uint32_t id);
307 virtual void selection_click (GdkEventButton*);
311 NamePackingBits name_packing;
313 static void compute_controls_size_info ();
314 static bool need_size_info;
316 void set_height_pixels (uint32_t h);
317 void color_handler (ColorID, uint32_t);
319 }; /* class TimeAxisView */
321 #endif /* __ardour_gtk_time_axis_h__ */