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