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