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         bool resizer_button_press (GdkEventButton*);
 118         bool resizer_button_release (GdkEventButton*);
 119         bool resizer_motion (GdkEventMotion*);
 120         bool resizer_expose (GdkEventExpose*);
 121
 122         void idle_resize (uint32_t);
 123
 124         void hide_name_label ();
 125         void hide_name_entry ();
 126         void show_name_label ();
 127         void show_name_entry ();
 128
 129         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 130         virtual void hide ();
 131
 132         void clip_to_viewport ();
 133
 134         bool touched (double top, double bot);
 135
 136         /** @return true if hidden, otherwise false */
 137         bool hidden () const { return _hidden; }
 138
 139         virtual void set_selected (bool);
 140
 141         /**
 142          * potential handler for entered events
 143          */
 144
 145         virtual void entered () {}
 146         virtual void exited () {}
 147
 148         virtual void set_height (uint32_t h);
 149         void set_height_enum (Height, bool apply_to_selection = false);
 150         void reset_height();
 151
 152         virtual void reset_visual_state ();
 153
 154         std::pair<TimeAxisView*, ARDOUR::layer_t> covers_y_position (double);
 155
 156         virtual void step_height (bool);
 157
 158         virtual ARDOUR::RouteGroup* route_group() const { return 0; }
 159         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 160
 161         virtual void set_samples_per_unit (double);
 162         virtual void show_selection (TimeSelection&);
 163         virtual void hide_selection ();
 164         virtual void reshow_selection (TimeSelection&);
 165         virtual void show_timestretch (framepos_t start, framepos_t end);
 166         virtual void hide_timestretch ();
 167
 168         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 169         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 170
 171         /* editing operations */
 172
 173         virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
 174         virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
 175
 176         virtual void set_selected_regionviews (RegionSelection&) {}
 177         virtual void set_selected_points (PointSelection&) {}
 178
 179         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
 180                 return boost::shared_ptr<ARDOUR::Region> ();
 181         }
 182
 183         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 184
 185         virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
 186         virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 187
 188         void add_ghost (RegionView*);
 189         void remove_ghost (RegionView*);
 190         void erase_ghost (GhostRegion*);
 191
 192         /** called at load time when first GUI idle occurs. put
 193             expensive data loading/redisplay code in here. */
 194         virtual void first_idle () {}
 195
 196         TimeAxisView* get_parent () { return parent; }
 197         void set_parent (TimeAxisView& p);
 198
 199         virtual LayerDisplay layer_display () const { return Overlaid; }
 200         virtual StreamView* view () const { return 0; }
 201
 202         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 203         Children get_child_list ();
 204
 205         SelectionRect* get_selection_rect(uint32_t id);
 206
 207         static uint32_t preset_height (Height);
 208
 209   protected:
 210         /* The Standard LHS Controls */
 211         Gtk::HBox             controls_hbox;
 212         Gtk::Table            controls_table;
 213         Gtk::EventBox         controls_ebox;
 214         Gtk::VBox             controls_vbox;
 215         Gtk::VBox             time_axis_vbox;
 216         Gtk::DrawingArea      resizer;
 217         Gtk::HBox             resizer_box;
 218         Gtk::HBox             name_hbox;
 219         Gtk::Frame            name_frame;
 220         Gtkmm2ext::FocusEntry name_entry;
 221
 222         uint32_t height;  /* in canvas units */
 223
 224         std::string controls_base_unselected_name;
 225         std::string controls_base_selected_name;
 226
 227         bool name_entry_button_press (GdkEventButton *ev);
 228         bool name_entry_button_release (GdkEventButton *ev);
 229         bool name_entry_key_release (GdkEventKey *ev);
 230         void name_entry_activated ();
 231         sigc::connection name_entry_key_timeout;
 232         bool name_entry_key_timed_out ();
 233         guint32 last_name_entry_key_press_event;
 234
 235         /* derived classes can override these */
 236
 237         virtual void name_entry_changed ();
 238         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 239         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 240
 241         /** Handle mouse relaese on our LHS control name ebox.
 242          *
 243          *@ param ev the event
 244          */
 245         virtual bool controls_ebox_button_release (GdkEventButton *ev);
 246         virtual bool controls_ebox_scroll (GdkEventScroll *ev);
 247
 248         /** Display the standard LHS control menu at when.
 249          *
 250          * @param when the popup activation time
 251          */
 252         virtual void popup_display_menu (guint32 when);
 253
 254         /** Build the standard LHS control menu.
 255          * Subclasses should extend this method to add their own menu options.
 256          */
 257         virtual void build_display_menu ();
 258
 259         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 260          */
 261         virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 262
 263         /* The standard LHS Track control popup-menus */
 264
 265         Gtk::Menu *display_menu;
 266
 267         Gtk::Label    name_label;
 268
 269         TimeAxisView* parent;
 270
 271         Children children;
 272         bool is_child (TimeAxisView*);
 273
 274         void remove_child (boost::shared_ptr<TimeAxisView>);
 275         void add_child (boost::shared_ptr<TimeAxisView>);
 276
 277         /* selection display */
 278
 279         ArdourCanvas::Group      *selection_group;
 280
 281         std::list<GhostRegion*> ghosts;
 282
 283         std::list<SelectionRect*> free_selection_rects;
 284         std::list<SelectionRect*> used_selection_rects;
 285
 286         virtual void selection_click (GdkEventButton*);
 287
 288         bool _hidden;
 289         bool _has_state;
 290         bool in_destructor;
 291         NamePackingBits name_packing;
 292
 293         void set_heights (uint32_t h);
 294         void color_handler ();
 295
 296         void conditionally_add_to_selection ();
 297
 298         void build_size_menu ();
 299         Gtk::Menu* _size_menu;
 300
 301         ArdourCanvas::Group* _canvas_display;
 302         double _y_position;
 303         PublicEditor& _editor;
 304
 305 private:
 306
 307         ArdourCanvas::Group* _canvas_background;
 308         Gtk::VBox* control_parent;
 309         int _order;
 310         uint32_t _effective_height;
 311         double _resize_drag_start;
 312         ArdourCanvas::Group* _ghost_group;
 313
 314         void compute_heights ();
 315         static uint32_t extra_height;
 316         static uint32_t small_height;
 317
 318         static int const _max_order;
 319
 320 }; /* class TimeAxisView */
 321
 322 #endif /* __ardour_gtk_time_axis_h__ */
 323