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*, double> 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, int layers, int layer);
 161         virtual void hide_timestretch ();
 162
 163         /* editing operations */
 164
 165         virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
 166         virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
 167
 168         virtual void set_selected_regionviews (RegionSelection&) {}
 169         virtual void set_selected_points (PointSelection&) {}
 170
 171         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
 172                 return boost::shared_ptr<ARDOUR::Region> ();
 173         }
 174
 175         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 176
 177         virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
 178         virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 179
 180         void add_ghost (RegionView*);
 181         void remove_ghost (RegionView*);
 182         void erase_ghost (GhostRegion*);
 183
 184         /** called at load time when first GUI idle occurs. put
 185             expensive data loading/redisplay code in here. */
 186         virtual void first_idle () {}
 187
 188         TimeAxisView* get_parent () { return parent; }
 189         void set_parent (TimeAxisView& p);
 190
 191         virtual LayerDisplay layer_display () const { return Overlaid; }
 192         virtual StreamView* view () const { return 0; }
 193
 194         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 195         Children get_child_list ();
 196
 197         SelectionRect* get_selection_rect(uint32_t id);
 198
 199         static uint32_t preset_height (Height);
 200
 201   protected:
 202         /* The Standard LHS Controls */
 203         Gtk::HBox             controls_hbox;
 204         Gtk::Table            controls_table;
 205         Gtk::EventBox         controls_ebox;
 206         Gtk::VBox             controls_vbox;
 207         Gtk::VBox             time_axis_vbox;
 208         Gtk::HBox             name_hbox;
 209         Gtk::Frame            name_frame;
 210         Gtkmm2ext::FocusEntry name_entry;
 211
 212         uint32_t height;  /* in canvas units */
 213
 214         std::string controls_base_unselected_name;
 215         std::string controls_base_selected_name;
 216
 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;
 224
 225         /* derived classes can override these */
 226
 227         virtual void name_entry_changed ();
 228         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 229         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 230
 231         /** Handle mouse relaese on our LHS control name ebox.
 232          *
 233          *@ param ev the event
 234          */
 235         virtual bool controls_ebox_button_release (GdkEventButton*);
 236         virtual bool controls_ebox_scroll (GdkEventScroll*);
 237         virtual bool controls_ebox_button_press (GdkEventButton*);
 238         virtual bool controls_ebox_motion (GdkEventMotion*);
 239         virtual bool controls_ebox_leave (GdkEventCrossing*);
 240
 241         /** Display the standard LHS control menu at when.
 242          *
 243          * @param when the popup activation time
 244          */
 245         virtual void popup_display_menu (guint32 when);
 246
 247         /** Build the standard LHS control menu.
 248          * Subclasses should extend this method to add their own menu options.
 249          */
 250         virtual void build_display_menu ();
 251
 252         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 253          */
 254         virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 255
 256         /* The standard LHS Track control popup-menus */
 257
 258         Gtk::Menu *display_menu;
 259
 260         Gtk::Label    name_label;
 261
 262         TimeAxisView* parent;
 263
 264         Children children;
 265         bool is_child (TimeAxisView*);
 266
 267         virtual void remove_child (boost::shared_ptr<TimeAxisView>);
 268         void add_child (boost::shared_ptr<TimeAxisView>);
 269
 270         /* selection display */
 271
 272         ArdourCanvas::Group      *selection_group;
 273
 274         std::list<GhostRegion*> ghosts;
 275
 276         std::list<SelectionRect*> free_selection_rects;
 277         std::list<SelectionRect*> used_selection_rects;
 278
 279         virtual void selection_click (GdkEventButton*);
 280
 281         bool _hidden;
 282         bool _has_state;
 283         bool in_destructor;
 284         NamePackingBits name_packing;
 285
 286         void color_handler ();
 287
 288         void conditionally_add_to_selection ();
 289
 290         void build_size_menu ();
 291         Gtk::Menu* _size_menu;
 292
 293         ArdourCanvas::Group* _canvas_display;
 294         double _y_position;
 295         PublicEditor& _editor;
 296
 297 private:
 298
 299         ArdourCanvas::Group* _canvas_background;
 300         Gtk::VBox* control_parent;
 301         int _order;
 302         uint32_t _effective_height;
 303         double _resize_drag_start;
 304         GdkCursor* _preresize_cursor;
 305         bool       _have_preresize_cursor;
 306         ArdourCanvas::Group* _ghost_group;
 307
 308         void compute_heights ();
 309         static uint32_t button_height;
 310         static uint32_t extra_height;
 311
 312         static int const _max_order;
 313
 314         bool maybe_set_cursor (int y);
 315
 316 }; /* class TimeAxisView */
 317
 318 #endif /* __ardour_gtk_time_axis_h__ */
 319