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