Merge branch 'master' into windows
[ardour.git] / gtk2_ardour / time_axis_view.h
index 1f401967eb917adeafcc8a4004b2f4205c9562cc..17dfec986b5fcb24706b8eedf7b5abbee02361dc 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
@@ -25,6 +25,7 @@
 
 #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 <gtkmm2ext/focus_entry.h>
 
-#include <ardour/types.h>
-#include <ardour/region.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"
-#include "color.h"
 
 namespace ARDOUR {
        class Session;
@@ -61,6 +65,10 @@ class PointSelection;
 class TimeAxisViewItem;
 class Selection;
 class Selectable;
+class RegionView;
+class GhostRegion;
+class StreamView;
+class ArdourDialog;
 
 /** Abstract base class for time-axis views (horizontal editor 'strips')
  *
@@ -76,72 +84,50 @@ class TimeAxisView : public virtual AxisView
        };
 
   public:
-       enum TrackHeight { 
-               Largest,
-               Large,
-               Larger,
-               Normal,
-               Smaller,
-               Small
-       };
-       
-       static uint32_t hLargest;
-       static uint32_t hLarge;
-       static uint32_t hLarger;
-       static uint32_t hNormal;
-       static uint32_t hSmaller;
-       static uint32_t hSmall;
-
-       static uint32_t height_to_pixels (TrackHeight);
 
-       TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
+       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;
-       
-       TrackHeight height_style; 
-       uint32_t    height;  /* in canvas units */
-       uint32_t    effective_height;  /* in canvas units */
-       double      y_position;
-       int         order;
-       
-       ArdourCanvas::Group *canvas_display;
-       Gtk::VBox           *control_parent;
+       /** @return index of this TimeAxisView within its parent */
+       int order () const { return _order; }
 
-       /* 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;
-       Gtkmm2ext::FocusEntry name_entry;
-       
-       void hide_name_label ();
-       void hide_name_entry ();
-       void show_name_label ();
-       void show_name_entry ();
+       /** @return maximum allowable value of order */
+       static int max_order () { return _max_order; }
+
+        virtual void enter_internal_edit_mode () {}
+        virtual void leave_internal_edit_mode () {}
+
+       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);
 
-       /** 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
@@ -150,92 +136,113 @@ class TimeAxisView : public virtual AxisView
        virtual void entered () {}
        virtual void exited () {}
 
-       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();
 
-       /**
-        * Returns a TimeAxisView* if this object covers y, or one of its children does.
-        *  If the covering object is a child axis, then the child is returned.
-        * Returns 0 otherwise.
-        */
+       virtual void reset_visual_state ();
 
-       TimeAxisView* covers_y_position (double y);
+       std::pair<TimeAxisView*, double> covers_y_position (double);
 
-       /**
-        * Steps through the defined heights 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 void step_height (bool);
 
-       virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
+       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 (nframes_t start, nframes_t end);
+       virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
        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 (nframes_t, float times, Selection&, size_t nth) { return false; }
-       
+
+       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 boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
+       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 (ArdourCanvas::Item *item, bool put_start_on_top);
 
-       virtual void get_selectables (nframes_t start, 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);
+
+       void add_ghost (RegionView*);
+       void remove_ghost (RegionView*);
+       void erase_ghost (GhostRegion*);
 
-       /* state/serialization management */
+       /** 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 (const string & childname) { return 0; }
+       SelectionRect* get_selection_rect(uint32_t id);
+       
+       static uint32_t preset_height (Height);
 
   protected:
+       /* 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::Label             name_label;
+        bool                  _name_editing;
+        uint32_t               height;  /* in canvas units */
+       std::string            controls_base_unselected_name;
+       std::string            controls_base_selected_name;
+       Gtk::Menu*             display_menu; /* The standard LHS Track control popup-menus */
+       TimeAxisView*          parent;
+       ArdourCanvas::Group*   selection_group;
+       std::list<GhostRegion*> ghosts;
+       std::list<SelectionRect*> free_selection_rects;
+       std::list<SelectionRect*> used_selection_rects;
+       bool                  _hidden;
+       bool                   in_destructor;
+       Gtk::Menu*            _size_menu;
+       ArdourCanvas::Group*  _canvas_display;
+       double                _y_position;
+       PublicEditor&         _editor;
+
+        virtual bool can_edit_name() const;
 
-       string controls_base_unselected_name;
-       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;
-       
+       bool name_entry_key_press (GdkEventKey *ev);
+       bool name_entry_focus_out (GdkEventFocus *ev);
+
+        Gtk::Entry* name_entry;
+        void begin_name_edit ();
+        void end_name_edit (int);
+
        /* 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 bool controls_ebox_button_release (GdkEventButton *ev);
-       virtual bool controls_ebox_scroll (GdkEventScroll *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*);
 
        /** Display the standard LHS control menu at when.
         *
@@ -250,62 +257,41 @@ class TimeAxisView : public virtual AxisView
 
        /** Do whatever needs to be done to dynamically reset the LHS control menu.
         */
-       virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
-
-       /** Build the standard LHS control size menu for the default heights options.
-        */
-       virtual void build_size_menu();
-
-       /** Displays the standard LHS controls size menu for the track heights
-        *
-        * @param when the popup activation time
-        */
-       void popup_size_menu(guint32 when);
-
-       /** Handle the size option of our main menu.
-        * 
-        * @param ev the event
-        */
-       gint size_click(GdkEventButton *ev);
-
-       /* The standard LHS Track control popup-menus */
-
-       Gtk::Menu *display_menu;
-       Gtk::Menu *size_menu;
-
-       Gtk::Label    name_label;
+       virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
 
-       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 */
 
-       ArdourCanvas::Group      *selection_group;
+       virtual void selection_click (GdkEventButton*);
 
-       list<SelectionRect*> free_selection_rects;
-       list<SelectionRect*> used_selection_rects;
+       void color_handler ();
 
-       SelectionRect* get_selection_rect(uint32_t id);
+       void conditionally_add_to_selection ();
 
-       virtual void selection_click (GdkEventButton*);
-
-       bool _hidden;
-       bool _has_state;
-       NamePackingBits name_packing;
+       void build_size_menu ();
 
-       static void compute_controls_size_info ();
-       static bool need_size_info;
+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;
+        bool                  _ebox_release_can_act;
 
-       void set_height_pixels (uint32_t h);
-       void color_handler (ColorID, uint32_t);
+       static uint32_t button_height;
+       static uint32_t extra_height;
+       static int const _max_order;
+       
+       void compute_heights ();
+       bool maybe_set_cursor (int y);
 
 }; /* class TimeAxisView */