Make TimeAxisView::remove_child virtual so that RouteTimeAxis can override it to...
[ardour.git] / gtk2_ardour / time_axis_view.h
index a89fd7a87fec68a7182627a3b425e563388ade66..9771c8b200d5d6be0689c9dac99de6b40fbec50c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2003 Paul Davis 
+    Copyright (C) 2003 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_gtk_time_axis_h__
 #include <vector>
 #include <list>
 
-#include <gtkmm.h>
-#include <libgnomecanvas/libgnomecanvas.h>
+#include <gtkmm/box.h>
+#include <gtkmm/frame.h>
+#include <gtkmm/drawingarea.h>
+#include <gtkmm/eventbox.h>
+#include <gtkmm/table.h>
+#include <gtkmm/entry.h>
+#include <gtkmm/label.h>
 
-#include <ardour/types.h>
-#include <ardour/region.h>
+#include <gtkmm2ext/focus_entry.h>
+
+#include "pbd/stateful.h"
+#include "pbd/signals.h"
+
+#include "ardour/types.h"
+#include "ardour/region.h"
+#include "evoral/Parameter.hpp"
 
 #include "prompter.h"
 #include "axis_view.h"
 #include "enums.h"
 #include "editing.h"
+#include "canvas.h"
 
 namespace ARDOUR {
        class Session;
@@ -43,83 +54,84 @@ namespace ARDOUR {
        class Playlist;
 }
 
+namespace Gtk {
+       class Menu;
+}
+
 class PublicEditor;
-class AudioRegionSelection;
+class RegionSelection;
 class TimeSelection;
 class PointSelection;
 class TimeAxisViewItem;
 class Selection;
 class Selectable;
+class RegionView;
+class GhostRegion;
+class StreamView;
 
-/**
- * TimeAxisView defines the abstract base class for time-axis views.
+/** Abstract base class for time-axis views (horizontal editor 'strips')
  *
  * This class provides the basic LHS controls and display methods. This should be
  * extended to create functional time-axis based views.
- *
  */
 class TimeAxisView : public virtual AxisView
 {
-  public:
-       enum TrackHeight { 
-                /* canvas units. they need to be odd
-                  valued so that there is a precise
-                  middle.
-               */
-               Largest = 301,
-               Large = 201,
-               Larger = 101,
-               Normal = 51,
-               Smaller = 31,
-               Small = 21
+  private:
+       enum NamePackingBits {
+               NameLabelPacked = 0x1,
+               NameEntryPacked = 0x2
        };
 
-       TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, Gtk::Widget *canvas);
+  public:
+
+       TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
        virtual ~TimeAxisView ();
 
-       /* public data: XXX create accessor/mutators for these ?? */
+       static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
 
-       PublicEditor& editor;
+       /** @return index of this TimeAxisView within its parent */
+       int order () const { return _order; }
 
-       guint32 height;  /* in canvas units */
-       guint32 effective_height;  /* in canvas units */
-       double  y_position;
-       int     order;
+       /** @return maximum allowable value of order */
+       static int max_order () { return _max_order; }
 
-       
-       GnomeCanvasItem   *canvas_display;
-       Gtk::VBox       *control_parent;
+        virtual void enter_internal_edit_mode () {}
+        virtual void leave_internal_edit_mode () {}
 
-       /* The Standard LHS Controls */
-       Gtk::Frame    controls_frame;
-       Gtk::HBox     controls_hbox;
-       Gtk::EventBox controls_lhs_pad;
-       Gtk::Table    controls_table;
-       Gtk::EventBox controls_ebox;
-       Gtk::VBox     controls_vbox;
-       Gtk::HBox     name_hbox;
-       Gtk::Frame    name_frame;
-       Gtk::Entry    name_entry;
+       ArdourCanvas::Group* canvas_display () { return _canvas_display; }
+       ArdourCanvas::Group* canvas_background () { return _canvas_background; }
+       ArdourCanvas::Group* ghost_group () { return _ghost_group; }
+
+       /** @return effective height (taking children into account) in canvas units, or
+           0 if this TimeAxisView has not yet been shown */
+       uint32_t effective_height () const { return _effective_height; }
+
+       /** @return y position, or -1 if hidden */
+       double y_position () const { return _y_position; }
+
+       /** @return our Editor */
+       PublicEditor& editor () const { return _editor; }
+
+       uint32_t current_height() const { return height; }
+
+       void idle_resize (uint32_t);
+
+       void hide_name_label ();
+       void hide_name_entry ();
+       void show_name_label ();
+       void show_name_entry ();
 
-       /**
-        * Display this TrackView as the nth component of the parent box, at y.
-        *
-        * @param y 
-        * @param nth
-        * @param parent the parent component
-        * @return the height of this TrackView
-        */
        virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
+       virtual void hide ();
+
+       void clip_to_viewport ();
 
        bool touched (double top, double bot);
 
-       /**
-        * Hides this TrackView
-        */
-       virtual void hide ();
-       bool hidden() const { return _hidden; }
+       /** @return true if hidden, otherwise false */
+       bool hidden () const { return _hidden; }
 
-       virtual void set_selected (bool);
+       void set_selected (bool);
 
        /**
         * potential handler for entered events
@@ -128,161 +140,182 @@ class TimeAxisView : public virtual AxisView
        virtual void entered () {}
        virtual void exited () {}
 
-       /**
-        * Sets the height of this TrackView to one of ths TrackHeghts
-        *
-        * @param h the TrackHeight value to set
-        */
-       virtual void set_height (TrackHeight h);
+       virtual void set_height (uint32_t h);
+       void set_height_enum (Height, bool apply_to_selection = false);
        void reset_height();
-       /**
-        * Steps through the defined TrackHeights for this TrackView.
-        * Sets bigger to true to step up in size, set to fals eot step smaller.
-        *
-        * @param bigger true if stepping should increase in size, false otherwise
-        */
-       virtual void step_height (bool bigger);
 
-       virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
-       virtual ARDOUR::Playlist* playlist() const { return 0; }
+       virtual void reset_visual_state ();
+
+       std::pair<TimeAxisView*, ARDOUR::layer_t> covers_y_position (double);
+
+       virtual void step_height (bool);
+
+       virtual ARDOUR::RouteGroup* route_group() const { return 0; }
+       virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 
        virtual void set_samples_per_unit (double);
        virtual void show_selection (TimeSelection&);
        virtual void hide_selection ();
        virtual void reshow_selection (TimeSelection&);
-       virtual void show_timestretch (jack_nframes_t start, jack_nframes_t end);
+       virtual void show_timestretch (framepos_t start, framepos_t end);
        virtual void hide_timestretch ();
 
        virtual void hide_dependent_views (TimeAxisViewItem&) {}
        virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 
        /* editing operations */
-       
-       virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
-       virtual bool paste (jack_nframes_t, float times, Selection&, size_t nth) { return false; }
-       
-       virtual void set_selected_regionviews (AudioRegionSelection&) {}
+
+       virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
+       virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
+
+       virtual void set_selected_regionviews (RegionSelection&) {}
        virtual void set_selected_points (PointSelection&) {}
 
-       virtual ARDOUR::Region* find_next_region (jack_nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
-               return 0;
+       virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
+               return boost::shared_ptr<ARDOUR::Region> ();
        }
 
-       void order_selection_trims (GnomeCanvasItem *item, bool put_start_on_top);
+       void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 
-       virtual void get_selectables (jack_nframes_t start, jack_nframes_t end, double top, double bot, list<Selectable*>& results);
-       virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
+       virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
+       virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
 
-       /* state/serialization management */
+       void add_ghost (RegionView*);
+       void remove_ghost (RegionView*);
+       void erase_ghost (GhostRegion*);
 
+       /** called at load time when first GUI idle occurs. put
+           expensive data loading/redisplay code in here. */
+       virtual void first_idle () {}
+
+       TimeAxisView* get_parent () { return parent; }
        void set_parent (TimeAxisView& p);
-       bool has_state () const;
 
-       virtual void set_state (const XMLNode&);
-       virtual XMLNode* get_state_node () { return 0; }
+       virtual LayerDisplay layer_display () const { return Overlaid; }
+       virtual StreamView* view () const { return 0; }
 
-       /* call this on the parent */
+       typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
+       Children get_child_list ();
 
-       virtual XMLNode* get_child_xml_node (std::string childname) { return 0; }
+       SelectionRect* get_selection_rect(uint32_t id);
+       
+       static uint32_t preset_height (Height);
 
   protected:
-
-       string controls_base_unselected_name;
-       string controls_base_selected_name;
-
-       /**
-        * Handle mouse press on our LHS control name entry.
+       /* The Standard LHS Controls */
+       Gtk::HBox             controls_hbox;
+       Gtk::Table            controls_table;
+       Gtk::EventBox         controls_ebox;
+       Gtk::VBox             controls_vbox;
+       Gtk::VBox             time_axis_vbox;
+       Gtk::HBox             name_hbox;
+       Gtk::Frame            name_frame;
+       Gtkmm2ext::FocusEntry name_entry;
+
+       uint32_t height;  /* in canvas units */
+
+       std::string controls_base_unselected_name;
+       std::string controls_base_selected_name;
+
+       bool name_entry_button_press (GdkEventButton *ev);
+       bool name_entry_button_release (GdkEventButton *ev);
+       bool name_entry_key_release (GdkEventKey *ev);
+       void name_entry_activated ();
+       sigc::connection name_entry_key_timeout;
+       bool name_entry_key_timed_out ();
+       guint32 last_name_entry_key_press_event;
+
+       /* derived classes can override these */
+
+       virtual void name_entry_changed ();
+       virtual bool name_entry_focus_in (GdkEventFocus *ev);
+       virtual bool name_entry_focus_out (GdkEventFocus *ev);
+
+       /** Handle mouse relaese on our LHS control name ebox.
         *
-        * @param ev the event
-        */
-       virtual gint name_entry_button_press (GdkEventButton *ev);
-
-       /**
-        * Handle mouse relaese on our LHS control name entry.
-        * 
-        *@ param ev the event
-        */
-       virtual gint name_entry_button_release (GdkEventButton *ev);
-
-       /**
-        * Handle mouse relaese on our LHS control name ebox.
-        * 
         *@ param ev the event
         */
-       virtual gint controls_ebox_button_release (GdkEventButton *ev);
+       virtual bool controls_ebox_button_release (GdkEventButton*);
+       virtual bool controls_ebox_scroll (GdkEventScroll*);
+       virtual bool controls_ebox_button_press (GdkEventButton*);
+       virtual bool controls_ebox_motion (GdkEventMotion*);
+       virtual bool controls_ebox_leave (GdkEventCrossing*);
 
-       /**
-        * Displays the standard LHS control menu at when.
+       /** Display the standard LHS control menu at when.
         *
         * @param when the popup activation time
         */
        virtual void popup_display_menu (guint32 when);
 
-       /**
-        * Build the standard LHS control menu.
+       /** Build the standard LHS control menu.
         * Subclasses should extend this method to add their own menu options.
-        *
         */
        virtual void build_display_menu ();
 
-       /**
-         * Do anything that needs to be done to dynamically reset
-        * the LHS control menu.
-        */
-       virtual gint handle_display_menu_map_event (GdkEventAny *ev) { return FALSE; }
-
-       /**
-        * Build the standard LHS control size menu for the default TrackHeight options.
-        *
+       /** Do whatever needs to be done to dynamically reset the LHS control menu.
         */
-       virtual void build_size_menu();
-
-       /**
-        * Displays the standard LHS controls size menu for the TrackHeight.
-        *
-        * @parem when the popup activation time
-        */
-       void popup_size_menu(guint32 when);
-
-       /**
-        * Handle the size option of out main menu.
-        * 
-        * @param ev the event
-        */
-       gint size_click(GdkEventButton *ev);
+       virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 
        /* The standard LHS Track control popup-menus */
 
        Gtk::Menu *display_menu;
-       Gtk::Menu *size_menu;
 
        Gtk::Label    name_label;
 
        TimeAxisView* parent;
 
-       /* find the parent with state */
-
-       TimeAxisView* get_parent_with_state();
-
-       std::vector<TimeAxisView*> children;
+       Children children;
        bool is_child (TimeAxisView*);
 
-       void remove_child (TimeAxisView*);
-       void add_child (TimeAxisView*);
+       virtual void remove_child (boost::shared_ptr<TimeAxisView>);
+       void add_child (boost::shared_ptr<TimeAxisView>);
 
        /* selection display */
 
-       GnomeCanvasItem      *selection_group;
+       ArdourCanvas::Group      *selection_group;
 
-       list<SelectionRect*> free_selection_rects;
-       list<SelectionRect*> used_selection_rects;
+       std::list<GhostRegion*> ghosts;
 
-       SelectionRect* get_selection_rect(uint32_t id);
+       std::list<SelectionRect*> free_selection_rects;
+       std::list<SelectionRect*> used_selection_rects;
 
        virtual void selection_click (GdkEventButton*);
 
        bool _hidden;
        bool _has_state;
+       bool in_destructor;
+       NamePackingBits name_packing;
+
+       void set_heights (uint32_t h);
+       void color_handler ();
+
+       void conditionally_add_to_selection ();
+
+       void build_size_menu ();
+       Gtk::Menu* _size_menu;
+
+       ArdourCanvas::Group* _canvas_display;
+       double _y_position;
+       PublicEditor& _editor;
+
+private:
+
+       ArdourCanvas::Group* _canvas_background;
+       Gtk::VBox* control_parent;
+       int _order;
+       uint32_t _effective_height;
+       double _resize_drag_start;
+       GdkCursor* _preresize_cursor;
+       bool       _have_preresize_cursor;
+       ArdourCanvas::Group* _ghost_group;
+
+       void compute_heights ();
+       static uint32_t button_height;
+       static uint32_t extra_height;
+
+       static int const _max_order;
+       
+       bool maybe_set_cursor (int y);
 
 }; /* class TimeAxisView */