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