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