gtk2_ardour/visual_time_axis.cc

   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 #include <cstdlib>
  21 #include <cmath>
  22 #include <algorithm>
  23 #include <string>
  24 #include <vector>
  25
  26 #include <pbd/error.h>
  27 #include <pbd/stl_delete.h>
  28 #include <pbd/whitespace.h>
  29
  30 #include <gtkmm2ext/utils.h>
  31 #include <gtkmm2ext/selector.h>
  32 #include <gtkmm2ext/gtk_ui.h>
  33 #include <gtkmm2ext/stop_signal.h>
  34 #include <gtkmm2ext/choice.h>
  35
  36 #include <ardour/session.h>
  37 #include <ardour/utils.h>
  38 #include <ardour/insert.h>
  39 #include <ardour/location.h>
  40
  41 #include "ardour_ui.h"
  42 #include "public_editor.h"
  43 #include "imageframe_time_axis.h"
  44 #include "imageframe_time_axis_view.h"
  45 #include "marker_time_axis_view.h"
  46 #include "imageframe_view.h"
  47 #include "marker_time_axis.h"
  48 #include "marker_view.h"
  49 #include "utils.h"
  50 #include "prompter.h"
  51 #include "rgb_macros.h"
  52 #include "canvas_impl.h"
  53
  54 #include "i18n.h"
  55
  56 using namespace ARDOUR;
  57 using namespace PBD;
  58 using namespace sigc;
  59 using namespace Gtk;
  60
  61 /**
  62  * Abstract Constructor for base visual time axis classes
  63  *
  64  * @param name the name/Id of thie TimeAxis
  65  * @param ed the Ardour PublicEditor
  66  * @param sess the current session
  67  * @param canvas the parent canvas object
  68  */
  69 VisualTimeAxis::VisualTimeAxis(const string & name, PublicEditor& ed, ARDOUR::Session& sess, Canvas& canvas)
  70         : AxisView(sess),
  71           TimeAxisView(sess,ed,(TimeAxisView*) 0, canvas),
  72           visual_button (_("v")),
  73           size_button (_("h"))
  74 {
  75         time_axis_name = name ;
  76         _color = unique_random_color() ;
  77         _marked_for_display = true;
  78
  79         name_entry.signal_activate().connect(mem_fun(*this, &VisualTimeAxis::name_entry_changed)) ;
  80         name_entry.signal_button_press_event().connect(mem_fun(*this, &VisualTimeAxis::name_entry_button_press_handler)) ;
  81         name_entry.signal_button_release_event().connect(mem_fun(*this, &VisualTimeAxis::name_entry_button_release_handler)) ;
  82         name_entry.signal_key_release_event().connect(mem_fun(*this, &VisualTimeAxis::name_entry_key_release_handler)) ;
  83
  84         size_button.set_name("TrackSizeButton") ;
  85         visual_button.set_name("TrackVisualButton") ;
  86         hide_button.set_name("TrackRemoveButton") ;
  87         hide_button.add(*(Gtk::manage(new Gtk::Image(get_xpm("small_x.xpm")))));
  88         size_button.signal_button_release_event().connect (mem_fun (*this, &VisualTimeAxis::size_click)) ;
  89         visual_button.signal_clicked().connect (mem_fun (*this, &VisualTimeAxis::visual_click)) ;
  90         hide_button.signal_clicked().connect (mem_fun (*this, &VisualTimeAxis::hide_click)) ;
  91         ARDOUR_UI::instance()->tooltips().set_tip(size_button,_("Display Height")) ;
  92         ARDOUR_UI::instance()->tooltips().set_tip(visual_button, _("Visual options")) ;
  93         ARDOUR_UI::instance()->tooltips().set_tip(hide_button, _("Hide this track")) ;
  94
  95         controls_table.attach (hide_button, 0, 1, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
  96         controls_table.attach (visual_button, 1, 2, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
  97         controls_table.attach (size_button, 2, 3, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
  98
  99         /* remove focus from the buttons */
 100         size_button.unset_flags(Gtk::CAN_FOCUS) ;
 101         hide_button.unset_flags(Gtk::CAN_FOCUS) ;
 102         visual_button.unset_flags(Gtk::CAN_FOCUS) ;
 103
 104         set_height (hNormal) ;
 105 }
 106
 107 /**
 108  * VisualTimeAxis Destructor
 109  *
 110  */
 111 VisualTimeAxis::~VisualTimeAxis()
 112 {
 113 }
 114
 115
 116 //---------------------------------------------------------------------------------------//
 117 // Name/Id Accessors/Mutators
 118
 119 void
 120 VisualTimeAxis::set_time_axis_name(const string & name, void* src)
 121 {
 122         std::string old_name = time_axis_name ;
 123
 124         if(name != time_axis_name)
 125         {
 126                 time_axis_name = name ;
 127                 label_view() ;
 128                 editor.route_name_changed(this) ;
 129
 130                  NameChanged(time_axis_name, old_name, src) ; /* EMIT_SIGNAL */
 131         }
 132 }
 133
 134 std::string
 135 VisualTimeAxis::name() const
 136 {
 137         return(time_axis_name) ;
 138 }
 139
 140
 141 //---------------------------------------------------------------------------------------//
 142 // ui methods & data
 143
 144 /**
 145  * Sets the height of this TrackView to one of the defined TrackHeghts
 146  *
 147  * @param h
 148  */
 149 void
 150 VisualTimeAxis::set_height(uint32_t h)
 151 {
 152         TimeAxisView::set_height(h);
 153
 154         if (h >= hNormal) {
 155                 hide_name_label ();
 156                 show_name_entry ();
 157                 other_button_hbox.show_all() ;
 158         } else if (h >= hSmaller) {
 159                 hide_name_label ();
 160                 show_name_entry ();
 161                 other_button_hbox.hide_all() ;
 162         } else if (h >= hSmall) {
 163                 hide_name_entry ();
 164                 show_name_label ();
 165                 other_button_hbox.hide_all() ;
 166         }
 167 }
 168
 169 /**
 170  * Handle the visuals button click
 171  *
 172  */
 173 void
 174 VisualTimeAxis::visual_click()
 175 {
 176         popup_display_menu(0);
 177 }
 178
 179
 180 /**
 181  * Handle the hide buttons click
 182  *
 183  */
 184 void
 185 VisualTimeAxis::hide_click()
 186 {
 187         // LAME fix for hide_button display refresh
 188         hide_button.set_sensitive(false);
 189
 190         editor.hide_track_in_display (*this);
 191
 192         hide_button.set_sensitive(true);
 193 }
 194
 195
 196 /**
 197  * Allows the selection of a new color for this TimeAxis
 198  *
 199  */
 200 void
 201 VisualTimeAxis::select_track_color ()
 202 {
 203         if(choose_time_axis_color())
 204         {
 205                 //Does nothing at this abstract point
 206         }
 207 }
 208
 209 /**
 210  * Provides a color chooser for the selection of a new time axis color.
 211  *
 212  */
 213 bool
 214 VisualTimeAxis::choose_time_axis_color()
 215 {
 216         bool picked ;
 217         Gdk::Color color ;
 218         gdouble current[4] ;
 219         Gdk::Color current_color ;
 220
 221         current[0] = _color.get_red() / 65535.0 ;
 222         current[1] = _color.get_green() / 65535.0 ;
 223         current[2] = _color.get_blue() / 65535.0 ;
 224         current[3] = 1.0 ;
 225
 226         current_color.set_rgb_p (current[0],current[1],current[2]);
 227         color = Gtkmm2ext::UI::instance()->get_color(_("ardour: color selection"),picked, &current_color) ;
 228
 229         if (picked)
 230         {
 231                 set_time_axis_color(color) ;
 232         }
 233         return(picked) ;
 234 }
 235
 236 /**
 237  * Sets the color of this TimeAxis to the specified color c
 238  *
 239  * @param c the new TimeAxis color
 240  */
 241 void
 242 VisualTimeAxis::set_time_axis_color(Gdk::Color c)
 243 {
 244         _color = c ;
 245 }
 246
 247 void
 248 VisualTimeAxis::set_selected_regionviews (RegionSelection& regions)
 249 {
 250         // Not handled by purely visual TimeAxis
 251 }
 252
 253 //---------------------------------------------------------------------------------------//
 254 // Handle time axis removal
 255
 256 /**
 257  * Handles the Removal of this VisualTimeAxis
 258  *
 259  * @param src the identity of the object that initiated the change
 260  */
 261 void
 262 VisualTimeAxis::remove_this_time_axis(void* src)
 263 {
 264         vector<string> choices;
 265
 266         std::string prompt  = string_compose (_("Do you really want to remove track \"%1\" ?\n(cannot be undone)"), time_axis_name);
 267
 268         choices.push_back (_("No, do nothing."));
 269         choices.push_back (_("Yes, remove it."));
 270
 271         Gtkmm2ext::Choice prompter (prompt, choices);
 272
 273         if (prompter.run () == 1) {
 274                 /*
 275                   defer to idle loop, otherwise we'll delete this object
 276                   while we're still inside this function ...
 277                 */
 278                 Glib::signal_idle().connect(bind(sigc::ptr_fun(&VisualTimeAxis::idle_remove_this_time_axis), this, src));
 279         }
 280 }
 281
 282 /**
 283  * Callback used to remove this time axis during the gtk idle loop
 284  * This is used to avoid deleting the obejct while inside the remove_this_time_axis
 285  * method
 286  *
 287  * @param ta the VisualTimeAxis to remove
 288  * @param src the identity of the object that initiated the change
 289  */
 290 gint
 291 VisualTimeAxis::idle_remove_this_time_axis(VisualTimeAxis* ta, void* src)
 292 {
 293          ta->VisualTimeAxisRemoved(ta->name(), src) ; /* EMIT_SIGNAL */
 294         delete ta ;
 295         ta = 0 ;
 296         return(false) ;
 297 }
 298
 299
 300
 301
 302 //---------------------------------------------------------------------------------------//
 303 // Handle TimeAxis rename
 304
 305 /**
 306  * Construct a new prompt to receive a new name for this TimeAxis
 307  *
 308  * @see finish_time_axis_rename()
 309  */
 310 void
 311 VisualTimeAxis::start_time_axis_rename()
 312 {
 313         ArdourPrompter name_prompter;
 314
 315         name_prompter.set_prompt (_("new name: ")) ;
 316         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
 317         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
 318         name_prompter.show_all() ;
 319
 320         switch (name_prompter.run ()) {
 321         case Gtk::RESPONSE_ACCEPT:
 322           string result;
 323           name_prompter.get_result (result);
 324           if (result.length()) {
 325                   if (editor.get_named_time_axis(result) != 0) {
 326                     ARDOUR_UI::instance()->popup_error (_("A track already exists with that name"));
 327                     return ;
 328                   }
 329
 330                   set_time_axis_name(result, this) ;
 331           }
 332         }
 333         label_view() ;
 334 }
 335
 336 /**
 337  * Handles the new name for this TimeAxis from the name prompt
 338  *
 339  * @see start_time_axis_rename()
 340  */
 341
 342 void
 343 VisualTimeAxis::label_view()
 344 {
 345         name_label.set_text(time_axis_name) ;
 346         name_entry.set_text(time_axis_name) ;
 347         ARDOUR_UI::instance()->tooltips().set_tip(name_entry, time_axis_name) ;
 348 }
 349
 350
 351 //---------------------------------------------------------------------------------------//
 352 // Handle name entry signals
 353
 354 void
 355 VisualTimeAxis::name_entry_changed()
 356 {
 357         string x = name_entry.get_text ();
 358
 359         if (x == time_axis_name) {
 360                 return;
 361         }
 362
 363         strip_whitespace_edges(x);
 364
 365         if (x.length() == 0) {
 366                 name_entry.set_text (time_axis_name);
 367                 return;
 368         }
 369
 370         if (!editor.get_named_time_axis(x)) {
 371                 set_time_axis_name(x, this);
 372         } else {
 373                 ARDOUR_UI::instance()->popup_error (_("A track already exists with that name"));
 374                 name_entry.set_text(time_axis_name);
 375         }
 376 }
 377
 378 gint
 379 VisualTimeAxis::name_entry_button_press_handler(GdkEventButton *ev)
 380 {
 381         if (ev->button == 3) {
 382                 return stop_signal (name_entry, "button_press_event");
 383         }
 384         return FALSE;
 385 }
 386
 387 gint
 388 VisualTimeAxis::name_entry_button_release_handler(GdkEventButton *ev)
 389 {
 390         return FALSE;
 391 }
 392
 393 gint
 394 VisualTimeAxis::name_entry_key_release_handler(GdkEventKey* ev)
 395 {
 396         switch (ev->keyval) {
 397         case GDK_Tab:
 398         case GDK_Up:
 399         case GDK_Down:
 400                 name_entry_changed ();
 401                 return TRUE;
 402
 403         default:
 404                 return FALSE;
 405         }
 406 }
 407
 408
 409 //---------------------------------------------------------------------------------------//
 410 // Super class methods not handled by VisualTimeAxis
 411
 412 void
 413 VisualTimeAxis::show_timestretch (nframes_t start, nframes_t end)
 414 {
 415   // Not handled by purely visual TimeAxis
 416 }
 417
 418 void
 419 VisualTimeAxis::hide_timestretch()
 420 {
 421   // Not handled by purely visual TimeAxis
 422 }
 423
 424