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