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     $Id$
  19 */
  20
  21 #ifndef __ardour_gtk_time_axis_h__
  22 #define __ardour_gtk_time_axis_h__
  23
  24 #include <vector>
  25 #include <list>
  26
  27 #include <gtkmm/box.h>
  28 #include <gtkmm/frame.h>
  29 #include <gtkmm/eventbox.h>
  30 #include <gtkmm/table.h>
  31 #include <gtkmm/entry.h>
  32 #include <gtkmm/label.h>
  33
  34 #include <ardour/types.h>
  35 #include <ardour/region.h>
  36
  37 #include "prompter.h"
  38 #include "axis_view.h"
  39 #include "enums.h"
  40 #include "editing.h"
  41 #include "canvas.h"
  42 #include "color.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 AudioRegionSelection;
  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         Gtk::Entry    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          * Steps through the defined heights for this TrackView.
 162          * Sets bigger to true to step up in size, set to fals eot step smaller.
 163          *
 164          * @param bigger true if stepping should increase in size, false otherwise
 165          */
 166         virtual void step_height (bool bigger);
 167
 168         virtual ARDOUR::RouteGroup* edit_group() const { return 0; }
 169         virtual ARDOUR::Playlist* playlist() const { return 0; }
 170
 171         virtual void set_samples_per_unit (double);
 172         virtual void show_selection (TimeSelection&);
 173         virtual void hide_selection ();
 174         virtual void reshow_selection (TimeSelection&);
 175         virtual void show_timestretch (jack_nframes_t start, jack_nframes_t end);
 176         virtual void hide_timestretch ();
 177
 178         virtual void hide_dependent_views (TimeAxisViewItem&) {}
 179         virtual void reveal_dependent_views (TimeAxisViewItem&) {}
 180
 181         /* editing operations */
 182
 183         virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
 184         virtual bool paste (jack_nframes_t, float times, Selection&, size_t nth) { return false; }
 185
 186         virtual void set_selected_regionviews (AudioRegionSelection&) {}
 187         virtual void set_selected_points (PointSelection&) {}
 188
 189         virtual ARDOUR::Region* find_next_region (jack_nframes_t pos, ARDOUR::RegionPoint, int32_t dir) {
 190                 return 0;
 191         }
 192
 193         void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
 194
 195         virtual void get_selectables (jack_nframes_t start, jack_nframes_t end, double top, double bot, list<Selectable*>& results);
 196         virtual void get_inverted_selectables (Selection&, list<Selectable *>& results);
 197
 198         /* state/serialization management */
 199
 200         void set_parent (TimeAxisView& p);
 201         bool has_state () const;
 202
 203         virtual void set_state (const XMLNode&);
 204         virtual XMLNode* get_state_node () { return 0; }
 205
 206         /* call this on the parent */
 207
 208         virtual XMLNode* get_child_xml_node (const string & childname) { return 0; }
 209
 210   protected:
 211
 212         string controls_base_unselected_name;
 213         string controls_base_selected_name;
 214
 215         bool name_entry_button_press (GdkEventButton *ev);
 216         bool name_entry_button_release (GdkEventButton *ev);
 217         bool name_entry_key_release (GdkEventKey *ev);
 218         void name_entry_activated ();
 219         sigc::connection name_entry_key_timeout;
 220         bool name_entry_key_timed_out ();
 221         guint32 last_name_entry_key_press_event;
 222
 223         /* derived classes can override these */
 224
 225         virtual void name_entry_changed ();
 226         virtual bool name_entry_focus_in (GdkEventFocus *ev);
 227         virtual bool name_entry_focus_out (GdkEventFocus *ev);
 228
 229         /**
 230          * Handle mouse relaese on our LHS control name ebox.
 231          *
 232          *@ param ev the event
 233          */
 234         virtual bool controls_ebox_button_release (GdkEventButton *ev);
 235         virtual bool controls_ebox_scroll (GdkEventScroll *ev);
 236
 237         /**
 238          * Displays the standard LHS control menu at when.
 239          *
 240          * @param when the popup activation time
 241          */
 242         virtual void popup_display_menu (guint32 when);
 243
 244         /**
 245          * Build the standard LHS control menu.
 246          * Subclasses should extend this method to add their own menu options.
 247          *
 248          */
 249         virtual void build_display_menu ();
 250
 251         /**
 252          * Do anything that needs to be done to dynamically reset
 253          * the LHS control menu.
 254          */
 255         virtual bool handle_display_menu_map_event (GdkEventAny *ev) { return false; }
 256
 257         /**
 258          * Build the standard LHS control size menu for the default heights options.
 259          *
 260          */
 261         virtual void build_size_menu();
 262
 263         /**
 264          * Displays the standard LHS controls size menu for the track heights
 265          *
 266          * @parem when the popup activation time
 267          */
 268         void popup_size_menu(guint32 when);
 269
 270         /**
 271          * Handle the size option of out main menu.
 272          *
 273          * @param ev the event
 274          */
 275         gint size_click(GdkEventButton *ev);
 276
 277         /* The standard LHS Track control popup-menus */
 278
 279         Gtk::Menu *display_menu;
 280         Gtk::Menu *size_menu;
 281
 282         Gtk::Label    name_label;
 283
 284         TimeAxisView* parent;
 285
 286         /* find the parent with state */
 287
 288         TimeAxisView* get_parent_with_state();
 289
 290         std::vector<TimeAxisView*> children;
 291         bool is_child (TimeAxisView*);
 292
 293         void remove_child (TimeAxisView*);
 294         void add_child (TimeAxisView*);
 295
 296         /* selection display */
 297
 298         ArdourCanvas::Group      *selection_group;
 299
 300         list<SelectionRect*> free_selection_rects;
 301         list<SelectionRect*> used_selection_rects;
 302
 303         SelectionRect* get_selection_rect(uint32_t id);
 304
 305         virtual void selection_click (GdkEventButton*);
 306
 307         bool _hidden;
 308         bool _has_state;
 309         NamePackingBits name_packing;
 310
 311         static void compute_controls_size_info ();
 312         static bool need_size_info;
 313
 314         void set_height_pixels (uint32_t h);
 315         void color_handler (ColorID, uint32_t);
 316
 317 }; /* class TimeAxisView */
 318
 319 #endif /* __ardour_gtk_time_axis_h__ */
 320