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
  83 /** Abstract base class for time-axis views (horizontal editor 'strips')
  84  *
  85  * This class provides the basic LHS controls and display methods. This should be
  86  * extended to create functional time-axis based views.
  87  */
  88 class TimeAxisView : public virtual AxisView
  89 {
  90         private:
  91         enum NamePackingBits {
  92                 NameLabelPacked = 0x1,
  93                 NameEntryPacked = 0x2
  94         };
  95
  96         public:
  97         TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
  98         virtual ~TimeAxisView ();
  99
 100         static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
 101
 102         /** @return index of this TimeAxisView within its parent */
 103         int order () const { return _order; }
 104
 105         /** @return maximum allowable value of order */
 106         static int max_order () { return _max_order; }
 107
 108         virtual void enter_internal_edit_mode () {}
 109         virtual void leave_internal_edit_mode () {}
 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 (uint32_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
 138         /**
 139          * potential handler for entered events
 140          */
 141
 142         virtual void entered () {}
 143         virtual void exited () {}
 144
 145         virtual void set_height (uint32_t h);
 146         void set_height_enum (Height, bool apply_to_selection = false);
 147         void reset_height();
 148
 149         virtual void reset_visual_state ();
 150
 151         std::pair<TimeAxisView*, double> covers_y_position (double) const;
 152         bool covered_by_y_range (double y0, double y1) const;
 153
 154         virtual void step_height (bool);
 155
 156         virtual ARDOUR::RouteGroup* route_group() const { return 0; }
 157         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 158
 159         virtual void set_samples_per_pixel (double);
 160         virtual void show_selection (TimeSelection&);
 161         virtual void hide_selection ();
 162         virtual void reshow_selection (TimeSelection&);
 163         virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
 164         virtual void hide_timestretch ();
 165
 166         /* editing operations */
 167
 168         virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
 169
 170         /** Paste a selection.
 171          *  @param pos Position to paste to (session frames).
 172          *  @param paste_count Number of pastes to the same location previously (multi-paste).
 173          *  @param times Number of times to paste.
 174          *  @param selection Selection to paste.
 175          *  @param counts Count of consumed selection items (used to find the
 176          *  correct item to paste here, then updated for the next pastee).
 177          */
 178         virtual bool paste (ARDOUR::framepos_t pos,
 179                             unsigned           paste_count,
 180                             float              times,
 181                             const Selection&   selection,
 182                             ItemCounts&        counts) { return false; }
 183
 184         virtual void set_selected_regionviews (RegionSelection&) {}
 185         virtual void set_selected_points (PointSelection&) {}
 186
 187         virtual void fade_range (TimeSelection&) {}
 188
 189         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
 190                 return boost::shared_ptr<ARDOUR::Region> ();
 191         }
 192
 193         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 194
 195         virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
 196         virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 197
 198         void add_ghost (RegionView*);
 199         void remove_ghost (RegionView*);
 200         void erase_ghost (GhostRegion*);
 201
 202         /** called at load time when first GUI idle occurs. put
 203             expensive data loading/redisplay code in here. */
 204         virtual void first_idle () {}
 205
 206         TimeAxisView* get_parent () { return parent; }
 207         void set_parent (TimeAxisView& p);
 208
 209         virtual LayerDisplay layer_display () const { return Overlaid; }
 210         virtual StreamView* view () const { return 0; }
 211
 212         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 213         Children get_child_list ();
 214
 215         SelectionRect* get_selection_rect(uint32_t id);
 216
 217         static uint32_t preset_height (Height);
 218
 219         protected:
 220         static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
 221         static Glib::RefPtr<Gtk::SizeGroup> midi_scroomer_size_group;
 222         static unsigned int name_width_px;
 223         /* The Standard LHS Controls */
 224         Gtk::Table             controls_table;
 225         Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
 226         Gtk::EventBox          controls_ebox;
 227         Gtk::VBox              controls_vbox;
 228         Gtk::VBox              time_axis_vbox;
 229         Gtk::HBox              time_axis_hbox;
 230         Gtk::Frame             time_axis_frame;
 231         Gtk::HBox              name_hbox;
 232         Gtk::HBox              top_hbox;
 233         Gtk::Label             name_label;
 234         Gtk::Fixed             scroomer_placeholder;
 235         bool                  _name_editing;
 236         uint32_t               height;  /* in canvas units */
 237         std::string            controls_base_unselected_name;
 238         std::string            controls_base_selected_name;
 239         Gtk::Menu*             display_menu; /* The standard LHS Track control popup-menus */
 240         TimeAxisView*          parent;
 241         ArdourCanvas::Container*   selection_group;
 242         ArdourCanvas::Container*  _ghost_group;
 243         std::list<GhostRegion*> ghosts;
 244         std::list<SelectionRect*> free_selection_rects;
 245         std::list<SelectionRect*> used_selection_rects;
 246         bool                  _hidden;
 247         bool                   in_destructor;
 248         Gtk::Menu*            _size_menu;
 249         ArdourCanvas::Line*       _canvas_separator;
 250         ArdourCanvas::Container*  _canvas_display;
 251         double                _y_position;
 252         PublicEditor&         _editor;
 253
 254         virtual bool can_edit_name() const;
 255
 256         bool name_entry_key_release (GdkEventKey *ev);
 257         bool name_entry_key_press (GdkEventKey *ev);
 258         bool name_entry_focus_out (GdkEventFocus *ev);
 259
 260         Gtk::Entry* name_entry;
 261         void begin_name_edit ();
 262         void end_name_edit (int);
 263
 264         /* derived classes can override these */
 265
 266         virtual void name_entry_changed ();
 267
 268         /** Handle mouse relaese on our LHS control name ebox.
 269          *
 270          *@ param ev the event
 271          */
 272         virtual bool controls_ebox_button_release (GdkEventButton*);
 273         virtual bool controls_ebox_scroll (GdkEventScroll*);
 274         virtual bool controls_ebox_button_press (GdkEventButton*);
 275         virtual bool controls_ebox_motion (GdkEventMotion*);
 276         virtual bool controls_ebox_leave (GdkEventCrossing*);
 277
 278         /** Display the standard LHS control menu at when.
 279          *
 280          * @param when the popup activation time
 281          */
 282         virtual void popup_display_menu (guint32 when);
 283
 284         /** Build the standard LHS control menu.
 285          * Subclasses should extend this method to add their own menu options.
 286          */
 287         virtual void build_display_menu ();
 288
 289         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 290          */
 291         virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 292
 293         Children children;
 294         bool is_child (TimeAxisView*);
 295
 296         virtual void remove_child (boost::shared_ptr<TimeAxisView>);
 297         void add_child (boost::shared_ptr<TimeAxisView>);
 298
 299         /* selection display */
 300
 301         virtual void selection_click (GdkEventButton*);
 302
 303         void color_handler ();
 304
 305         void conditionally_add_to_selection ();
 306
 307         void build_size_menu ();
 308
 309 private:
 310         Gtk::VBox*            control_parent;
 311         int                  _order;
 312         uint32_t             _effective_height;
 313         double               _resize_drag_start;
 314         bool                 _did_resize;
 315         GdkCursor*           _preresize_cursor;
 316         bool                 _have_preresize_cursor;
 317         bool                 _ebox_release_can_act;
 318
 319         static uint32_t button_height;
 320         static uint32_t extra_height;
 321         static int const _max_order;
 322
 323         void compute_heights ();
 324         bool maybe_set_cursor (int y);
 325
 326 }; /* class TimeAxisView */
 327
 328 #endif /* __ardour_gtk_time_axis_h__ */