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 #include <gtkmm/sizegroup.h>
  34
  35 #include <gtkmm2ext/focus_entry.h>
  36
  37 #include "pbd/stateful.h"
  38 #include "pbd/signals.h"
  39
  40 #include "ardour/types.h"
  41 #include "ardour/region.h"
  42 #include "evoral/Parameter.hpp"
  43
  44 #include "canvas/line.h"
  45
  46 #include "prompter.h"
  47 #include "axis_view.h"
  48 #include "enums.h"
  49 #include "editing.h"
  50
  51 namespace ARDOUR {
  52         class Session;
  53         class Region;
  54         class Session;
  55         class RouteGroup;
  56         class Playlist;
  57 }
  58
  59 namespace Gtk {
  60         class Menu;
  61 }
  62
  63 namespace ArdourCanvas {
  64         class Canvas;
  65         class Container;
  66         class Item;
  67 }
  68
  69 class PublicEditor;
  70 class RegionSelection;
  71 class TimeSelection;
  72 class PointSelection;
  73 class TimeAxisViewItem;
  74 class Selection;
  75 class Selectable;
  76 class RegionView;
  77 class GhostRegion;
  78 class StreamView;
  79 class ArdourDialog;
  80
  81 /** Abstract base class for time-axis views (horizontal editor 'strips')
  82  *
  83  * This class provides the basic LHS controls and display methods. This should be
  84  * extended to create functional time-axis based views.
  85  */
  86 class TimeAxisView : public virtual AxisView
  87 {
  88         private:
  89         enum NamePackingBits {
  90                 NameLabelPacked = 0x1,
  91                 NameEntryPacked = 0x2
  92         };
  93
  94         public:
  95         TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
  96         virtual ~TimeAxisView ();
  97
  98         static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
  99
 100         /** @return index of this TimeAxisView within its parent */
 101         int order () const { return _order; }
 102
 103         /** @return maximum allowable value of order */
 104         static int max_order () { return _max_order; }
 105
 106         virtual void enter_internal_edit_mode () {}
 107         virtual void leave_internal_edit_mode () {}
 108
 109         ArdourCanvas::Container* canvas_display () { return _canvas_display; }
 110         ArdourCanvas::Container* ghost_group () { return _ghost_group; }
 111
 112         /** @return effective height (taking children into account) in canvas units, or
 113                 0 if this TimeAxisView has not yet been shown */
 114         uint32_t effective_height () const { return _effective_height; }
 115
 116         /** @return y position, or -1 if hidden */
 117         double y_position () const { return _y_position; }
 118
 119         /** @return our Editor */
 120         PublicEditor& editor () const { return _editor; }
 121
 122         uint32_t current_height() const { return height; }
 123
 124         void idle_resize (uint32_t);
 125
 126         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 127         virtual void hide ();
 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) const;
 150         bool covered_by_y_range (double y0, double y1) const;
 151
 152         virtual void step_height (bool);
 153
 154         virtual ARDOUR::RouteGroup* route_group() const { return 0; }
 155         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 156
 157         virtual void set_samples_per_pixel (double);
 158         virtual void show_selection (TimeSelection&);
 159         virtual void hide_selection ();
 160         virtual void reshow_selection (TimeSelection&);
 161         virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
 162         virtual void hide_timestretch ();
 163
 164         /* editing operations */
 165
 166         virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
 167         virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
 168
 169         virtual void set_selected_regionviews (RegionSelection&) {}
 170         virtual void set_selected_points (PointSelection&) {}
 171
 172         virtual void fade_range (TimeSelection&) {}
 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         static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
 206         static unsigned int name_width_px;
 207         /* The Standard LHS Controls */
 208         Gtk::Table             controls_table;
 209         Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
 210         Gtk::EventBox          controls_ebox;
 211         Gtk::VBox              controls_vbox;
 212         Gtk::VBox              time_axis_vbox;
 213         Gtk::HBox              time_axis_hbox;
 214         Gtk::Frame             time_axis_frame;
 215         Gtk::HBox              name_hbox;
 216         Gtk::HBox              top_hbox;
 217         Gtk::Label             name_label;
 218         bool                  _name_editing;
 219         uint32_t               height;  /* in canvas units */
 220         std::string            controls_base_unselected_name;
 221         std::string            controls_base_selected_name;
 222         Gtk::Menu*             display_menu; /* The standard LHS Track control popup-menus */
 223         TimeAxisView*          parent;
 224         ArdourCanvas::Container*   selection_group;
 225         ArdourCanvas::Container*  _ghost_group;
 226         std::list<GhostRegion*> ghosts;
 227         std::list<SelectionRect*> free_selection_rects;
 228         std::list<SelectionRect*> used_selection_rects;
 229         bool                  _hidden;
 230         bool                   in_destructor;
 231         Gtk::Menu*            _size_menu;
 232         ArdourCanvas::Line*       _canvas_separator;
 233         ArdourCanvas::Container*  _canvas_display;
 234         double                _y_position;
 235         PublicEditor&         _editor;
 236
 237         virtual bool can_edit_name() const;
 238
 239         bool name_entry_key_release (GdkEventKey *ev);
 240         bool name_entry_key_press (GdkEventKey *ev);
 241         bool name_entry_focus_out (GdkEventFocus *ev);
 242
 243         Gtk::Entry* name_entry;
 244         void begin_name_edit ();
 245         void end_name_edit (int);
 246
 247         /* derived classes can override these */
 248
 249         virtual void name_entry_changed ();
 250
 251         /** Handle mouse relaese on our LHS control name ebox.
 252          *
 253          *@ param ev the event
 254          */
 255         virtual bool controls_ebox_button_release (GdkEventButton*);
 256         virtual bool controls_ebox_scroll (GdkEventScroll*);
 257         virtual bool controls_ebox_button_press (GdkEventButton*);
 258         virtual bool controls_ebox_motion (GdkEventMotion*);
 259         virtual bool controls_ebox_leave (GdkEventCrossing*);
 260
 261         /** Display the standard LHS control menu at when.
 262          *
 263          * @param when the popup activation time
 264          */
 265         virtual void popup_display_menu (guint32 when);
 266
 267         /** Build the standard LHS control menu.
 268          * Subclasses should extend this method to add their own menu options.
 269          */
 270         virtual void build_display_menu ();
 271
 272         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 273          */
 274         virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 275
 276         Children children;
 277         bool is_child (TimeAxisView*);
 278
 279         virtual void remove_child (boost::shared_ptr<TimeAxisView>);
 280         void add_child (boost::shared_ptr<TimeAxisView>);
 281
 282         /* selection display */
 283
 284         virtual void selection_click (GdkEventButton*);
 285
 286         void color_handler ();
 287
 288         void conditionally_add_to_selection ();
 289
 290         void build_size_menu ();
 291
 292 private:
 293         Gtk::VBox*            control_parent;
 294         int                  _order;
 295         uint32_t             _effective_height;
 296         double               _resize_drag_start;
 297         GdkCursor*           _preresize_cursor;
 298         bool                 _have_preresize_cursor;
 299         bool                  _ebox_release_can_act;
 300
 301         static uint32_t button_height;
 302         static uint32_t extra_height;
 303         static int const _max_order;
 304
 305         void compute_heights ();
 306         bool maybe_set_cursor (int y);
 307
 308 }; /* class TimeAxisView */
 309
 310 #endif /* __ardour_gtk_time_axis_h__ */