gtk2_ardour/time_axis_view.h

   1 /*
   2     Copyright (C) 2003 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_gtk_time_axis_h__
  21 #define __ardour_gtk_time_axis_h__
  22
  23 #include <vector>
  24 #include <list>
  25
  26 #include <gtkmm/box.h>
  27 #include <gtkmm/frame.h>
  28 #include <gtkmm/drawingarea.h>
  29 #include <gtkmm/eventbox.h>
  30 #include <gtkmm/table.h>
  31 #include <gtkmm/entry.h>
  32 #include <gtkmm/label.h>
  33
  34 #include <gtkmm2ext/focus_entry.h>
  35
  36 #include "pbd/stateful.h"
  37 #include "pbd/signals.h"
  38
  39 #include "ardour/types.h"
  40 #include "ardour/region.h"
  41 #include "evoral/Parameter.hpp"
  42
  43 #include "prompter.h"
  44 #include "axis_view.h"
  45 #include "enums.h"
  46 #include "editing.h"
  47 #include "canvas.h"
  48
  49 namespace ARDOUR {
  50         class Session;
  51         class Region;
  52         class Session;
  53         class RouteGroup;
  54         class Playlist;
  55 }
  56
  57 namespace Gtk {
  58         class Menu;
  59 }
  60
  61 class PublicEditor;
  62 class RegionSelection;
  63 class TimeSelection;
  64 class PointSelection;
  65 class TimeAxisViewItem;
  66 class Selection;
  67 class Selectable;
  68 class RegionView;
  69 class GhostRegion;
  70 class StreamView;
  71
  72 /** Abstract base class for time-axis views (horizontal editor 'strips')
  73  *
  74  * This class provides the basic LHS controls and display methods. This should be
  75  * extended to create functional time-axis based views.
  76  */
  77 class TimeAxisView : public virtual AxisView
  78 {
  79   private:
  80         enum NamePackingBits {
  81                 NameLabelPacked = 0x1,
  82                 NameEntryPacked = 0x2
  83         };
  84
  85   public:
  86
  87         TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
  88         virtual ~TimeAxisView ();
  89
  90         static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
  91
  92         /** @return index of this TimeAxisView within its parent */
  93         int order () const { return _order; }
  94
  95         /** @return maximum allowable value of order */
  96         static int max_order () { return _max_order; }
  97
  98         virtual void enter_internal_edit_mode () {}
  99         virtual void leave_internal_edit_mode () {}
 100
 101         ArdourCanvas::Group* canvas_display () { return _canvas_display; }
 102         ArdourCanvas::Group* canvas_background () { return _canvas_background; }
 103         ArdourCanvas::Group* ghost_group () { return _ghost_group; }
 104
 105         /** @return effective height (taking children into account) in canvas units, or
 106             0 if this TimeAxisView has not yet been shown */
 107         uint32_t effective_height () const { return _effective_height; }
 108
 109         /** @return y position, or -1 if hidden */
 110         double y_position () const { return _y_position; }
 111
 112         /** @return our Editor */
 113         PublicEditor& editor () const { return _editor; }
 114
 115         uint32_t current_height() const { return height; }
 116
 117         void idle_resize (uint32_t);
 118
 119         void hide_name_label ();
 120         void hide_name_entry ();
 121         void show_name_label ();
 122         void show_name_entry ();
 123
 124         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 125         virtual void hide ();
 126
 127         void clip_to_viewport ();
 128
 129         bool touched (double top, double bot);
 130
 131         /** @return true if hidden, otherwise false */
 132         bool hidden () const { return _hidden; }
 133
 134         void set_selected (bool);
 135
 136         /**
 137          * potential handler for entered events
 138          */
 139
 140         virtual void entered () {}
 141         virtual void exited () {}
 142
 143         virtual void set_height (uint32_t h);
 144         void set_height_enum (Height, bool apply_to_selection = false);
 145         void reset_height();
 146
 147         virtual void reset_visual_state ();
 148
 149         std::pair<TimeAxisView*, ARDOUR::layer_t> covers_y_position (double);
 150
 151         virtual void step_height (bool);
 152
 153         virtual ARDOUR::RouteGroup* route_group() const { return 0; }
 154         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 155
 156         virtual void set_samples_per_unit (double);
 157         virtual void show_selection (TimeSelection&);
 158         virtual void hide_selection ();
 159         virtual void reshow_selection (TimeSelection&);
 160         virtual void show_timestretch (framepos_t start, framepos_t end);
 161         virtual void hide_timestretch ();
 162
 163         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 164         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 165
 166         /* editing operations */
 167
 168         virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
 169         virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
 170
 171         virtual void set_selected_regionviews (RegionSelection&) {}
 172         virtual void set_selected_points (PointSelection&) {}
 173
 174         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
 175                 return boost::shared_ptr<ARDOUR::Region> ();
 176         }
 177
 178         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 179
 180         virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
 181         virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 182
 183         void add_ghost (RegionView*);
 184         void remove_ghost (RegionView*);
 185         void erase_ghost (GhostRegion*);
 186
 187         /** called at load time when first GUI idle occurs. put
 188             expensive data loading/redisplay code in here. */
 189         virtual void first_idle () {}
 190
 191         TimeAxisView* get_parent () { return parent; }
 192         void set_parent (TimeAxisView& p);
 193
 194         virtual LayerDisplay layer_display () const { return Overlaid; }
 195         virtual StreamView* view () const { return 0; }
 196
 197         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 198         Children get_child_list ();
 199
 200         SelectionRect* get_selection_rect(uint32_t id);
 201
 202         static uint32_t preset_height (Height);
 203
 204   protected:
 205         /* The Standard LHS Controls */
 206         Gtk::HBox             controls_hbox;
 207         Gtk::Table            controls_table;
 208         Gtk::EventBox         controls_ebox;
 209         Gtk::VBox             controls_vbox;
 210         Gtk::VBox             time_axis_vbox;
 211         Gtk::HBox             name_hbox;
 212         Gtk::Frame            name_frame;
 213         Gtkmm2ext::FocusEntry name_entry;
 214
 215         uint32_t height;  /* in canvas units */
 216
 217         std::string controls_base_unselected_name;
 218         std::string controls_base_selected_name;
 219
 220         bool name_entry_button_press (GdkEventButton *ev);
 221         bool name_entry_button_release (GdkEventButton *ev);
 222         bool name_entry_key_release (GdkEventKey *ev);
 223         void name_entry_activated ();
 224         sigc::connection name_entry_key_timeout;
 225         bool name_entry_key_timed_out ();
 226         guint32 last_name_entry_key_press_event;
 227
 228         /* derived classes can override these */
 229
 230         virtual void name_entry_changed ();
 231         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 232         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 233
 234         /** Handle mouse relaese on our LHS control name ebox.
 235          *
 236          *@ param ev the event
 237          */
 238         virtual bool controls_ebox_button_release (GdkEventButton*);
 239         virtual bool controls_ebox_scroll (GdkEventScroll*);
 240         virtual bool controls_ebox_button_press (GdkEventButton*);
 241         virtual bool controls_ebox_motion (GdkEventMotion*);
 242         virtual bool controls_ebox_leave (GdkEventCrossing*);
 243
 244         /** Display the standard LHS control menu at when.
 245          *
 246          * @param when the popup activation time
 247          */
 248         virtual void popup_display_menu (guint32 when);
 249
 250         /** Build the standard LHS control menu.
 251          * Subclasses should extend this method to add their own menu options.
 252          */
 253         virtual void build_display_menu ();
 254
 255         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 256          */
 257         virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 258
 259         /* The standard LHS Track control popup-menus */
 260
 261         Gtk::Menu *display_menu;
 262
 263         Gtk::Label    name_label;
 264
 265         TimeAxisView* parent;
 266
 267         Children children;
 268         bool is_child (TimeAxisView*);
 269
 270         virtual void remove_child (boost::shared_ptr<TimeAxisView>);
 271         void add_child (boost::shared_ptr<TimeAxisView>);
 272
 273         /* selection display */
 274
 275         ArdourCanvas::Group      *selection_group;
 276
 277         std::list<GhostRegion*> ghosts;
 278
 279         std::list<SelectionRect*> free_selection_rects;
 280         std::list<SelectionRect*> used_selection_rects;
 281
 282         virtual void selection_click (GdkEventButton*);
 283
 284         bool _hidden;
 285         bool _has_state;
 286         bool in_destructor;
 287         NamePackingBits name_packing;
 288
 289         void set_heights (uint32_t h);
 290         void color_handler ();
 291
 292         void conditionally_add_to_selection ();
 293
 294         void build_size_menu ();
 295         Gtk::Menu* _size_menu;
 296
 297         ArdourCanvas::Group* _canvas_display;
 298         double _y_position;
 299         PublicEditor& _editor;
 300
 301 private:
 302
 303         ArdourCanvas::Group* _canvas_background;
 304         Gtk::VBox* control_parent;
 305         int _order;
 306         uint32_t _effective_height;
 307         double _resize_drag_start;
 308         GdkCursor* _preresize_cursor;
 309         bool       _have_preresize_cursor;
 310         ArdourCanvas::Group* _ghost_group;
 311
 312         void compute_heights ();
 313         static uint32_t button_height;
 314         static uint32_t extra_height;
 315
 316         static int const _max_order;
 317
 318         bool maybe_set_cursor (int y);
 319
 320 }; /* class TimeAxisView */
 321
 322 #endif /* __ardour_gtk_time_axis_h__ */
 323