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