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         int32_t resize_idle_id;
 129         bool idle_resize();
 130
 131         void hide_name_label ();
 132         void hide_name_entry ();
 133         void show_name_label ();
 134         void show_name_entry ();
 135
 136         /**
 137          * Display this TrackView as the nth component of the parent box, at y.
 138          *
 139          * @param y
 140          * @param nth
 141          * @param parent the parent component
 142          * @return the height of this TrackView
 143          */
 144         virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
 145
 146         bool touched (double top, double bot);
 147
 148         /**
 149          * Hides this TrackView
 150          */
 151         virtual void hide ();
 152         bool hidden() const { return _hidden; }
 153
 154         virtual void set_selected (bool);
 155
 156         /**
 157          * potential handler for entered events
 158          */
 159
 160         virtual void entered () {}
 161         virtual void exited () {}
 162
 163         virtual void set_height (uint32_t h);
 164         void reset_height();
 165
 166         /**
 167          * Returns a TimeAxisView* if this object covers y, or one of its children does.
 168          *  If the covering object is a child axis, then the child is returned.
 169          * Returns 0 otherwise.
 170          */
 171
 172         TimeAxisView* covers_y_position (double y);
 173
 174         /**
 175          * Steps through the defined heights for this TrackView.
 176          * Sets bigger to true to step up in size, set to fals eot step smaller.
 177          *
 178          * @param bigger true if stepping should increase in size, false otherwise
 179          */
 180         virtual void step_height (bool bigger);
 181
 182         virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
 183         virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
 184
 185         virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
 186         virtual void hide_feature_lines ();
 187
 188         virtual void set_samples_per_unit (double);
 189         virtual void show_selection (TimeSelection&);
 190         virtual void hide_selection ();
 191         virtual void reshow_selection (TimeSelection&);
 192         virtual void show_timestretch (nframes_t start, nframes_t end);
 193         virtual void hide_timestretch ();
 194
 195         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 196         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 197
 198         /* editing operations */
 199
 200         virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
 201         virtual bool paste (nframes_t, float times, Selection&, size_t nth) { return false; }
 202
 203         virtual void set_selected_regionviews (RegionSelection&) {}
 204         virtual void set_selected_points (PointSelection&) {}
 205
 206         virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
 207                 return boost::shared_ptr<ARDOUR::Region> ();
 208         }
 209
 210         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 211
 212         virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, list<Selectable*>& results);
 213         virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
 214
 215         /* called at load time when first GUI idle occurs. put
 216            expensive data loading/redisplay code in here.
 217         */
 218
 219         virtual void first_idle () {}
 220
 221         /* state/serialization management */
 222
 223         void set_parent (TimeAxisView& p);
 224         bool has_state () const;
 225
 226         /* call this on the parent */
 227
 228         virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
 229
 230   protected:
 231         uint32_t height;  /* in canvas units */
 232
 233         string controls_base_unselected_name;
 234         string controls_base_selected_name;
 235
 236         bool name_entry_button_press (GdkEventButton *ev);
 237         bool name_entry_button_release (GdkEventButton *ev);
 238         bool name_entry_key_release (GdkEventKey *ev);
 239         void name_entry_activated ();
 240         sigc::connection name_entry_key_timeout;
 241         bool name_entry_key_timed_out ();
 242         guint32 last_name_entry_key_press_event;
 243
 244         /* derived classes can override these */
 245
 246         virtual void name_entry_changed ();
 247         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 248         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 249
 250         /**
 251          * Handle mouse relaese on our LHS control name ebox.
 252          *
 253          *@ param ev the event
 254          */
 255         virtual bool controls_ebox_button_release (GdkEventButton *ev);
 256         virtual bool controls_ebox_scroll (GdkEventScroll *ev);
 257
 258         /**
 259          * Displays the standard LHS control menu at when.
 260          *
 261          * @param when the popup activation time
 262          */
 263         virtual void popup_display_menu (guint32 when);
 264
 265         /**
 266          * Build the standard LHS control menu.
 267          * Subclasses should extend this method to add their own menu options.
 268          *
 269          */
 270         virtual void build_display_menu ();
 271
 272         /**
 273          * Do anything that needs to be done to dynamically reset
 274          * the LHS control menu.
 275          */
 276         virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
 277
 278         /**
 279          * Build the standard LHS control size menu for the default heights options.
 280          *
 281          */
 282         virtual void build_size_menu();
 283
 284         /**
 285          * Displays the standard LHS controls size menu for the track heights
 286          *
 287          * @parem when the popup activation time
 288          */
 289         void popup_size_menu(guint32 when);
 290
 291         /**
 292          * Handle the size option of out main menu.
 293          *
 294          * @param ev the event
 295          */
 296         gint size_click(GdkEventButton *ev);
 297
 298         /* The standard LHS Track control popup-menus */
 299
 300         Gtk::Menu *display_menu;
 301         Gtk::Menu *size_menu;
 302
 303         Gtk::Label    name_label;
 304
 305         TimeAxisView* parent;
 306
 307         /* find the parent with state */
 308
 309         TimeAxisView* get_parent_with_state();
 310
 311         std::vector<TimeAxisView*> children;
 312         bool is_child (TimeAxisView*);
 313
 314         void remove_child (TimeAxisView*);
 315         void add_child (TimeAxisView*);
 316
 317         /* selection display */
 318
 319         ArdourCanvas::Group      *selection_group;
 320
 321         list<SelectionRect*> free_selection_rects;
 322         list<SelectionRect*> used_selection_rects;
 323
 324         SelectionRect* get_selection_rect(uint32_t id);
 325
 326         virtual void selection_click (GdkEventButton*);
 327
 328         bool _hidden;
 329         bool _has_state;
 330         NamePackingBits name_packing;
 331
 332         static void compute_controls_size_info ();
 333         static bool need_size_info;
 334
 335         void set_heights (uint32_t h);
 336         void color_handler ();
 337
 338         list<ArdourCanvas::SimpleLine*> feature_lines;
 339         ARDOUR::AnalysisFeatureList analysis_features;
 340         void reshow_feature_lines ();
 341
 342         void conditionally_add_to_selection ();
 343
 344 }; /* class TimeAxisView */
 345
 346 #endif /* __ardour_gtk_time_axis_h__ */
 347