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