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"
58 class RegionSelection;
61 class TimeAxisViewItem;
66 * TimeAxisView defines the abstract base class for time-axis views.
68 * This class provides the basic LHS controls and display methods. This should be
69 * extended to create functional time-axis based views.
72 class TimeAxisView : public virtual AxisView
75 enum NamePackingBits {
76 NameLabelPacked = 0x1,
90 static uint32_t hLargest;
91 static uint32_t hLarge;
92 static uint32_t hLarger;
93 static uint32_t hNormal;
94 static uint32_t hSmaller;
95 static uint32_t hSmall;
97 static uint32_t height_to_pixels (TrackHeight);
99 TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
100 virtual ~TimeAxisView ();
102 /* public data: XXX create accessor/mutators for these ?? */
104 PublicEditor& editor;
106 TrackHeight height_style;
107 uint32_t height; /* in canvas units */
108 uint32_t effective_height; /* in canvas units */
112 ArdourCanvas::Group *canvas_display;
113 Gtk::VBox *control_parent;
115 /* The Standard LHS Controls */
116 Gtk::Frame controls_frame;
117 Gtk::HBox controls_hbox;
118 Gtk::EventBox controls_lhs_pad;
119 Gtk::Table controls_table;
120 Gtk::EventBox controls_ebox;
121 Gtk::VBox controls_vbox;
123 Gtk::Frame name_frame;
124 Gtkmm2ext::FocusEntry name_entry;
126 void hide_name_label ();
127 void hide_name_entry ();
128 void show_name_label ();
129 void show_name_entry ();
132 * Display this TrackView as the nth component of the parent box, at y.
136 * @param parent the parent component
137 * @return the height of this TrackView
139 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
141 bool touched (double top, double bot);
144 * Hides this TrackView
146 virtual void hide ();
147 bool hidden() const { return _hidden; }
149 virtual void set_selected (bool);
152 * potential handler for entered events
155 virtual void entered () {}
156 virtual void exited () {}
158 virtual void set_height (TrackHeight h);
162 * Returns a TimeAxisView* if this object covers y, or one of its children does.
163 * If the covering object is a child axis, then the child is returned.
164 * Returns 0 otherwise.
167 TimeAxisView* covers_y_position (double y);
170 * Steps through the defined heights for this TrackView.
171 * Sets bigger to true to step up in size, set to fals eot step smaller.
173 * @param bigger true if stepping should increase in size, false otherwise
175 virtual void step_height (bool bigger);
177 virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
178 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
180 virtual void set_samples_per_unit (double);
181 virtual void show_selection (TimeSelection&);
182 virtual void hide_selection ();
183 virtual void reshow_selection (TimeSelection&);
184 virtual void show_timestretch (nframes_t start, nframes_t end);
185 virtual void hide_timestretch ();
187 virtual void hide_dependent_views (TimeAxisViewItem&) {}
188 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
190 /* editing operations */
192 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
193 virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
195 virtual void set_selected_regionviews (RegionSelection&) {}
196 virtual void set_selected_points (PointSelection&) {}
198 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
199 return boost::shared_ptr<ARDOUR::Region> ();
202 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
204 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
205 virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
207 /* state/serialization management */
209 void set_parent (TimeAxisView& p);
210 bool has_state () const;
212 virtual void set_state (const XMLNode&);
213 virtual XMLNode* get_state_node () { return 0; }
215 /* call this on the parent */
217 virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
221 string controls_base_unselected_name;
222 string controls_base_selected_name;
224 bool name_entry_button_press (GdkEventButton *ev);
225 bool name_entry_button_release (GdkEventButton *ev);
226 bool name_entry_key_release (GdkEventKey *ev);
227 void name_entry_activated ();
228 sigc::connection name_entry_key_timeout;
229 bool name_entry_key_timed_out ();
230 guint32 last_name_entry_key_press_event;
232 /* derived classes can override these */
234 virtual void name_entry_changed ();
235 virtual bool name_entry_focus_in (GdkEventFocus *ev);
236 virtual bool name_entry_focus_out (GdkEventFocus *ev);
239 * Handle mouse relaese on our LHS control name ebox.
241 *@ param ev the event
243 virtual bool controls_ebox_button_release (GdkEventButton *ev);
244 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
247 * Displays the standard LHS control menu at when.
249 * @param when the popup activation time
251 virtual void popup_display_menu (guint32 when);
254 * Build the standard LHS control menu.
255 * Subclasses should extend this method to add their own menu options.
258 virtual void build_display_menu ();
261 * Do anything that needs to be done to dynamically reset
262 * the LHS control menu.
264 virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
267 * Build the standard LHS control size menu for the default heights options.
270 virtual void build_size_menu();
273 * Displays the standard LHS controls size menu for the track heights
275 * @parem when the popup activation time
277 void popup_size_menu(guint32 when);
280 * Handle the size option of out main menu.
282 * @param ev the event
284 gint size_click(GdkEventButton *ev);
286 /* The standard LHS Track control popup-menus */
288 Gtk::Menu *display_menu;
289 Gtk::Menu *size_menu;
291 Gtk::Label name_label;
293 TimeAxisView* parent;
295 /* find the parent with state */
297 TimeAxisView* get_parent_with_state();
299 std::vector<TimeAxisView*> children;
300 bool is_child (TimeAxisView*);
302 void remove_child (TimeAxisView*);
303 void add_child (TimeAxisView*);
305 /* selection display */
307 ArdourCanvas::Group *selection_group;
309 list<SelectionRect*> free_selection_rects;
310 list<SelectionRect*> used_selection_rects;
312 SelectionRect* get_selection_rect(uint32_t id);
314 virtual void selection_click (GdkEventButton*);
318 NamePackingBits name_packing;
320 static void compute_controls_size_info ();
321 static bool need_size_info;
323 void set_height_pixels (uint32_t h);
324 void color_handler (ColorID, uint32_t);
326 }; /* class TimeAxisView */
328 #endif /* __ardour_gtk_time_axis_h__ */