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/frame.h>
  28 #include <gtkmm/drawingarea.h>
  29 #include <gtkmm/eventbox.h>
  30 #include <gtkmm/table.h>
  31 #include <gtkmm/entry.h>
  32 #include <gtkmm/label.h>
  33
  34 #include <gtkmm2ext/focus_entry.h>
  35
  36 #include <pbd/stateful.h>
  37
  38 #include <ardour/types.h>
  39 #include <ardour/region.h>
  40 #include <evoral/Parameter.hpp>
  41
  42 #include "prompter.h"
  43 #include "axis_view.h"
  44 #include "enums.h"
  45 #include "editing.h"
  46 #include "canvas.h"
  47
  48 namespace ARDOUR {
  49         class Session;
  50         class Region;
  51         class Session;
  52         class RouteGroup;
  53         class Playlist;
  54 }
  55
  56 namespace Gtk {
  57         class Menu;
  58 }
  59
  60 class PublicEditor;
  61 class RegionSelection;
  62 class TimeSelection;
  63 class PointSelection;
  64 class TimeAxisViewItem;
  65 class Selection;
  66 class Selectable;
  67 class RegionView;
  68 class GhostRegion;
  69
  70 /** Abstract base class for time-axis views (horizontal editor 'strips')
  71  *
  72  * This class provides the basic LHS controls and display methods. This should be
  73  * extended to create functional time-axis based views.
  74  */
  75 class TimeAxisView : public virtual AxisView, public PBD::Stateful
  76 {
  77   private:
  78         enum NamePackingBits {
  79                 NameLabelPacked = 0x1,
  80                 NameEntryPacked = 0x2
  81         };
  82
  83   public:
  84         static uint32_t hLargest;
  85         static uint32_t hLarge;
  86         static uint32_t hLarger;
  87         static uint32_t hNormal;
  88         static uint32_t hSmaller;
  89         static uint32_t hSmall;
  90
  91         TimeAxisView(ARDOUR::Session& sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
  92         virtual ~TimeAxisView ();
  93
  94         XMLNode& get_state (void);
  95         int set_state (const XMLNode&);
  96
  97         /* public data: XXX create accessor/mutators for these ?? */
  98
  99         PublicEditor& editor;
 100
 101         uint32_t effective_height;  /* in canvas units */
 102         double   y_position;
 103         int      order;
 104
 105         uint32_t current_height() const { return height; }
 106
 107         ArdourCanvas::Group   *canvas_background;
 108         ArdourCanvas::Group   *canvas_display;
 109         Gtk::VBox       *control_parent;
 110
 111         /* The Standard LHS Controls */
 112         Gtk::Frame    controls_frame;
 113         Gtk::HBox     controls_hbox;
 114         Gtk::EventBox controls_lhs_pad;
 115         Gtk::Table    controls_table;
 116         Gtk::EventBox controls_ebox;
 117         Gtk::VBox     controls_vbox;
 118         Gtk::DrawingArea resizer;
 119         Gtk::HBox     resizer_box;
 120         Gtk::HBox     name_hbox;
 121         Gtk::Frame    name_frame;
 122         Gtkmm2ext::FocusEntry name_entry;
 123
 124         bool resizer_button_press (GdkEventButton*);
 125         bool resizer_button_release (GdkEventButton*);
 126         bool resizer_motion (GdkEventMotion*);
 127         bool resizer_expose (GdkEventExpose*);
 128
 129         double resize_drag_start;
 130         int32_t resize_idle_target;
 131         void idle_resize (uint32_t);
 132
 133         void hide_name_label ();
 134         void hide_name_entry ();
 135         void show_name_label ();
 136         void show_name_entry ();
 137
 138         /** Display this TrackView as the nth component of the parent box, at y.
 139          *
 140          * @param y
 141          * @param nth
 142          * @param parent the parent component
 143          * @return the height of this TrackView
 144          */
 145         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 146
 147         void clip_to_viewport ();
 148
 149         bool touched (double top, double bot);
 150
 151         /** Hides this TrackView */
 152         virtual void hide ();
 153         bool hidden() const { return _hidden; }
 154
 155         virtual void set_selected (bool);
 156
 157         /**
 158          * potential handler for entered events
 159          */
 160
 161         virtual void entered () {}
 162         virtual void exited () {}
 163
 164         virtual void set_height (uint32_t h);
 165         void reset_height();
 166
 167         /**
 168          * Returns a TimeAxisView* if this object covers y, or one of its children does.
 169          *  If the covering object is a child axis, then the child is returned.
 170          * Returns 0 otherwise.
 171          */
 172
 173         TimeAxisView* covers_y_position (double y);
 174
 175         /**
 176          * Steps through the defined heights for this TrackView.
 177          * Sets bigger to true to step up in size, set to fals eot step smaller.
 178          *
 179          * @param bigger true if stepping should increase in size, false otherwise
 180          */
 181         virtual void step_height (bool bigger);
 182
 183         virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
 184         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 185
 186         virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
 187         virtual void hide_feature_lines ();
 188
 189         virtual void set_samples_per_unit (double);
 190         virtual void show_selection (TimeSelection&);
 191         virtual void hide_selection ();
 192         virtual void reshow_selection (TimeSelection&);
 193         virtual void show_timestretch (nframes_t start, nframes_t end);
 194         virtual void hide_timestretch ();
 195
 196         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 197         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 198
 199         /* editing operations */
 200
 201         virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
 202         virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
 203
 204         virtual void set_selected_regionviews (RegionSelection&) {}
 205         virtual void set_selected_points (PointSelection&) {}
 206
 207         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
 208                 return boost::shared_ptr<ARDOUR::Region> ();
 209         }
 210
 211         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 212
 213         virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
 214         virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
 215
 216         ArdourCanvas::Group* ghost_group;
 217
 218         void add_ghost (RegionView*);
 219         void remove_ghost (RegionView*);
 220         void erase_ghost (GhostRegion*);
 221
 222         /* called at load time when first GUI idle occurs. put
 223            expensive data loading/redisplay code in here.
 224         */
 225
 226         virtual void first_idle () {}
 227
 228         /* state/serialization management */
 229
 230         TimeAxisView* get_parent () { return parent; }
 231         void set_parent (TimeAxisView& p);
 232         bool has_state () const;
 233
 234         /* call this on the parent */
 235
 236         virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param) { return 0; }
 237
 238         typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
 239
 240   protected:
 241         uint32_t height;  /* in canvas units */
 242
 243         string controls_base_unselected_name;
 244         string controls_base_selected_name;
 245
 246         bool name_entry_button_press (GdkEventButton *ev);
 247         bool name_entry_button_release (GdkEventButton *ev);
 248         bool name_entry_key_release (GdkEventKey *ev);
 249         void name_entry_activated ();
 250         sigc::connection name_entry_key_timeout;
 251         bool name_entry_key_timed_out ();
 252         guint32 last_name_entry_key_press_event;
 253
 254         /* derived classes can override these */
 255
 256         virtual void name_entry_changed ();
 257         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 258         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 259
 260         /** Handle mouse relaese on our LHS control name ebox.
 261          *
 262          *@ param ev the event
 263          */
 264         virtual bool controls_ebox_button_release (GdkEventButton *ev);
 265         virtual bool controls_ebox_scroll (GdkEventScroll *ev);
 266
 267         /** Display the standard LHS control menu at when.
 268          *
 269          * @param when the popup activation time
 270          */
 271         virtual void popup_display_menu (guint32 when);
 272
 273         /** Build the standard LHS control menu.
 274          * Subclasses should extend this method to add their own menu options.
 275          */
 276         virtual void build_display_menu ();
 277
 278         /** Do whatever needs to be done to dynamically reset the LHS control menu.
 279          */
 280         virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
 281
 282         /** Build the standard LHS control size menu for the default heights options.
 283          */
 284         virtual void build_size_menu();
 285
 286         /** Displays the standard LHS controls size menu for the track heights
 287          *
 288          * @param when the popup activation time
 289          */
 290         void popup_size_menu(guint32 when);
 291
 292         /** Handle the size option of our main menu.
 293          *
 294          * @param ev the event
 295          */
 296         gint size_click(GdkEventButton *ev);
 297
 298         /* The standard LHS Track control popup-menus */
 299
 300         Gtk::Menu *display_menu;
 301         Gtk::Menu *size_menu;
 302
 303         Gtk::Label    name_label;
 304
 305         TimeAxisView* parent;
 306
 307         /** Find the parent with state */
 308         TimeAxisView* get_parent_with_state();
 309
 310         Children children;
 311         bool is_child (TimeAxisView*);
 312
 313         void remove_child (boost::shared_ptr<TimeAxisView>);
 314         void add_child (boost::shared_ptr<TimeAxisView>);
 315
 316         /* selection display */
 317
 318         ArdourCanvas::Group      *selection_group;
 319
 320         list<GhostRegion*> ghosts;
 321
 322         list<SelectionRect*> free_selection_rects;
 323         list<SelectionRect*> used_selection_rects;
 324
 325         SelectionRect* get_selection_rect(uint32_t id);
 326
 327         virtual void selection_click (GdkEventButton*);
 328
 329         bool _hidden;
 330         bool _has_state;
 331         bool in_destructor;
 332         NamePackingBits name_packing;
 333
 334         static void compute_controls_size_info ();
 335         static bool need_size_info;
 336
 337         void set_heights (uint32_t h);
 338         void color_handler ();
 339
 340
 341         std::list<ArdourCanvas::SimpleLine*> feature_lines;
 342         ARDOUR::AnalysisFeatureList analysis_features;
 343         void reshow_feature_lines ();
 344
 345         void conditionally_add_to_selection ();
 346
 347 }; /* class TimeAxisView */
 348
 349 #endif /* __ardour_gtk_time_axis_h__ */
 350