gtk2_ardour/time_axis_view.cc

   1 /*
   2     Copyright (C) 2000 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 <list>
  25
  26 #include <libgnomecanvasmm.h>
  27 #include <libgnomecanvasmm/canvas.h>
  28 #include <libgnomecanvasmm/item.h>
  29
  30 #include "pbd/error.h"
  31 #include "pbd/convert.h"
  32
  33 #include <gtkmm2ext/utils.h>
  34 #include <gtkmm2ext/selector.h>
  35 #include <gtkmm2ext/stop_signal.h>
  36
  37 #include "ardour/session.h"
  38 #include "ardour/utils.h"
  39 #include "ardour/ladspa_plugin.h"
  40 #include "ardour/processor.h"
  41 #include "ardour/location.h"
  42
  43 #include "ardour_ui.h"
  44 #include "gui_thread.h"
  45 #include "public_editor.h"
  46 #include "time_axis_view.h"
  47 #include "region_view.h"
  48 #include "ghostregion.h"
  49 #include "simplerect.h"
  50 #include "simpleline.h"
  51 #include "selection.h"
  52 #include "keyboard.h"
  53 #include "rgb_macros.h"
  54 #include "utils.h"
  55 #include "streamview.h"
  56
  57 #include "i18n.h"
  58
  59 using namespace std;
  60 using namespace Gtk;
  61 using namespace Gdk;
  62 using namespace ARDOUR;
  63 using namespace PBD;
  64 using namespace Editing;
  65 using namespace ArdourCanvas;
  66 using Gtkmm2ext::Keyboard;
  67
  68 const double trim_handle_size = 6.0; /* pixels */
  69
  70 uint32_t TimeAxisView::hLargest = 0;
  71 uint32_t TimeAxisView::hLarge = 0;
  72 uint32_t TimeAxisView::hLarger = 0;
  73 uint32_t TimeAxisView::hNormal = 0;
  74 uint32_t TimeAxisView::hSmaller = 0;
  75 uint32_t TimeAxisView::hSmall = 0;
  76 bool TimeAxisView::need_size_info = true;
  77 int const TimeAxisView::_max_order = 512;
  78 PBD::Signal1<void,TimeAxisView*> TimeAxisView::CatchDeletion;
  79
  80 TimeAxisView::TimeAxisView (ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* rent, Canvas& /*canvas*/)
  81         : AxisView (sess),
  82           controls_table (2, 8),
  83           _y_position (0),
  84           _editor (ed),
  85           _order (0)
  86 {
  87         if (need_size_info) {
  88                 compute_controls_size_info ();
  89                 need_size_info = false;
  90         }
  91         _canvas_background = new Group (*ed.get_background_group (), 0.0, 0.0);
  92         _canvas_display = new Group (*ed.get_trackview_group (), 0.0, 0.0);
  93         _canvas_display->hide(); // reveal as needed
  94
  95         selection_group = new Group (*_canvas_display);
  96         selection_group->hide();
  97
  98         _ghost_group = new Group (*_canvas_display);
  99         _ghost_group->lower_to_bottom();
 100         _ghost_group->show();
 101
 102         control_parent = 0;
 103         display_menu = 0;
 104         size_menu = 0;
 105         _hidden = false;
 106         in_destructor = false;
 107         height = 0;
 108         _effective_height = 0;
 109         parent = rent;
 110         _has_state = false;
 111         last_name_entry_key_press_event = 0;
 112         name_packing = NamePackingBits (0);
 113         _resize_drag_start = -1;
 114
 115         /*
 116           Create the standard LHS Controls
 117           We create the top-level container and name add the name label here,
 118           subclasses can add to the layout as required
 119         */
 120
 121         name_entry.set_name ("EditorTrackNameDisplay");
 122         name_entry.signal_button_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_button_release));
 123         name_entry.signal_button_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_button_press));
 124         name_entry.signal_key_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_release));
 125         name_entry.signal_activate().connect (sigc::mem_fun(*this, &TimeAxisView::name_entry_activated));
 126         name_entry.signal_focus_in_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_focus_in));
 127         name_entry.signal_focus_out_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_focus_out));
 128         Gtkmm2ext::set_size_request_to_display_given_text (name_entry, N_("gTortnam"), 10, 10); // just represents a short name
 129
 130         name_label.set_name ("TrackLabel");
 131         name_label.set_alignment (0.0, 0.5);
 132
 133         /* typically, either name_label OR name_entry are visible,
 134            but not both. its up to derived classes to show/hide them as they
 135            wish.
 136         */
 137
 138         name_hbox.show ();
 139
 140         controls_table.set_size_request (200);
 141         controls_table.set_border_width (2);
 142         controls_table.set_row_spacings (0);
 143         controls_table.set_col_spacings (0);
 144         controls_table.set_homogeneous (true);
 145
 146         controls_table.attach (name_hbox, 0, 5, 0, 1,  Gtk::FILL|Gtk::EXPAND,  Gtk::FILL|Gtk::EXPAND, 3, 0);
 147         controls_table.show_all ();
 148         controls_table.set_no_show_all ();
 149
 150         resizer.set_size_request (10, 10);
 151         resizer.set_name ("ResizeHandle");
 152         resizer.signal_expose_event().connect (sigc::mem_fun (*this, &TimeAxisView::resizer_expose));
 153         resizer.signal_button_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::resizer_button_press));
 154         resizer.signal_button_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::resizer_button_release));
 155         resizer.signal_motion_notify_event().connect (sigc::mem_fun (*this, &TimeAxisView::resizer_motion));
 156         resizer.set_events (Gdk::BUTTON_PRESS_MASK|
 157                         Gdk::BUTTON_RELEASE_MASK|
 158                         Gdk::POINTER_MOTION_MASK|
 159                         Gdk::SCROLL_MASK);
 160
 161         resizer_box.pack_start (resizer, false, false);
 162         resizer.show ();
 163         resizer_box.show();
 164
 165         HSeparator* separator = manage (new HSeparator());
 166
 167         controls_vbox.pack_start (controls_table, false, false);
 168         controls_vbox.pack_end (*separator, false, false);
 169         controls_vbox.pack_end (resizer_box, false, true);
 170         controls_vbox.show ();
 171
 172         //controls_ebox.set_name ("TimeAxisViewControlsBaseUnselected");
 173         controls_ebox.add (controls_vbox);
 174         controls_ebox.add_events (BUTTON_PRESS_MASK|BUTTON_RELEASE_MASK|SCROLL_MASK);
 175         controls_ebox.set_flags (CAN_FOCUS);
 176
 177         controls_ebox.signal_button_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_button_release));
 178         controls_ebox.signal_scroll_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_scroll), true);
 179
 180         controls_hbox.pack_start (controls_ebox,true,true);
 181         controls_hbox.show ();
 182
 183         ColorsChanged.connect (sigc::mem_fun (*this, &TimeAxisView::color_handler));
 184
 185         GhostRegion::CatchDeletion.connect (*this, ui_bind (&TimeAxisView::erase_ghost, this, _1), gui_context());
 186 }
 187
 188 TimeAxisView::~TimeAxisView()
 189 {
 190         in_destructor = true;
 191
 192         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 193                 delete *i;
 194         }
 195
 196         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 197                 delete (*i)->rect;
 198                 delete (*i)->start_trim;
 199                 delete (*i)->end_trim;
 200
 201         }
 202
 203         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 204                 delete (*i)->rect;
 205                 delete (*i)->start_trim;
 206                 delete (*i)->end_trim;
 207         }
 208
 209         for (list<SimpleLine*>::iterator i = feature_lines.begin(); i != feature_lines.end(); ++i) {
 210                 delete (*i);
 211         }
 212
 213         delete selection_group;
 214         selection_group = 0;
 215
 216         delete _canvas_background;
 217         _canvas_background = 0;
 218
 219         delete _canvas_display;
 220         _canvas_display = 0;
 221
 222         delete display_menu;
 223         display_menu = 0;
 224 }
 225
 226 /** Display this TimeAxisView as the nth component of the parent box, at y.
 227 *
 228 * @param y y position.
 229 * @param nth index for this TimeAxisView, increased if this view has children.
 230 * @param parent parent component.
 231 * @return height of this TimeAxisView.
 232 */
 233 guint32
 234 TimeAxisView::show_at (double y, int& nth, VBox *parent)
 235 {
 236         if (control_parent) {
 237                 control_parent->reorder_child (controls_hbox, nth);
 238         } else {
 239                 control_parent = parent;
 240                 parent->pack_start (controls_hbox, false, false);
 241                 parent->reorder_child (controls_hbox, nth);
 242         }
 243
 244         _order = nth;
 245
 246         if (_y_position != y) {
 247                 _canvas_display->property_y () = y;
 248                 _canvas_background->property_y () = y;
 249                 /* silly canvas */
 250                 _canvas_display->move (0.0, 0.0);
 251                 _canvas_background->move (0.0, 0.0);
 252                 _y_position = y;
 253
 254         }
 255
 256         _canvas_background->raise_to_top ();
 257         _canvas_display->raise_to_top ();
 258
 259         if (_marked_for_display) {
 260                 controls_hbox.show ();
 261                 controls_ebox.show ();
 262                 _canvas_background->show ();
 263         }
 264
 265         _hidden = false;
 266
 267         _effective_height = current_height ();
 268
 269         /* now show children */
 270
 271         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 272                 if (canvas_item_visible ((*i)->_canvas_display)) {
 273                         ++nth;
 274                         _effective_height += (*i)->show_at (y + _effective_height, nth, parent);
 275                 }
 276         }
 277
 278         return _effective_height;
 279 }
 280
 281 void
 282 TimeAxisView::clip_to_viewport ()
 283 {
 284         if (_marked_for_display) {
 285                 if (_y_position + _effective_height < _editor.get_trackview_group_vertical_offset () || _y_position > _editor.get_trackview_group_vertical_offset () + _canvas_display->get_canvas()->get_height()) {
 286                         _canvas_background->hide ();
 287                         _canvas_display->hide ();
 288                         return;
 289                 }
 290                 _canvas_background->show ();
 291                 _canvas_display->show ();
 292         }
 293         return;
 294 }
 295
 296 bool
 297 TimeAxisView::controls_ebox_scroll (GdkEventScroll* ev)
 298 {
 299         if (Keyboard::some_magic_widget_has_focus()) {
 300                 return false;
 301         }
 302
 303         switch (ev->direction) {
 304         case GDK_SCROLL_UP:
 305                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
 306                         step_height (true);
 307                         return true;
 308                 } else if (Keyboard::no_modifiers_active (ev->state)) {
 309                         _editor.scroll_tracks_up_line();
 310                         return true;
 311                 }
 312                 break;
 313
 314         case GDK_SCROLL_DOWN:
 315                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
 316                         step_height (false);
 317                         return true;
 318                 } else if (Keyboard::no_modifiers_active (ev->state)) {
 319                         _editor.scroll_tracks_down_line();
 320                         return true;
 321                 }
 322                 break;
 323
 324         default:
 325                 /* no handling for left/right, yet */
 326                 break;
 327         }
 328
 329         return false;
 330 }
 331
 332 bool
 333 TimeAxisView::controls_ebox_button_release (GdkEventButton* ev)
 334 {
 335         switch (ev->button) {
 336         case 1:
 337                 selection_click (ev);
 338                 break;
 339
 340         case 3:
 341                 popup_display_menu (ev->time);
 342                 break;
 343         }
 344
 345         return true;
 346 }
 347
 348 void
 349 TimeAxisView::selection_click (GdkEventButton* ev)
 350 {
 351         Selection::Operation op = ArdourKeyboard::selection_type (ev->state);
 352         _editor.set_selected_track (*this, op, false);
 353 }
 354
 355 void
 356 TimeAxisView::hide ()
 357 {
 358         if (_hidden) {
 359                 return;
 360         }
 361
 362         _canvas_display->hide ();
 363         _canvas_background->hide ();
 364
 365         if (control_parent) {
 366                 control_parent->remove (controls_hbox);
 367                 control_parent = 0;
 368         }
 369
 370         _y_position = -1;
 371         _hidden = true;
 372
 373         /* now hide children */
 374
 375         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 376                 (*i)->hide ();
 377         }
 378
 379         /* if its hidden, it cannot be selected */
 380
 381         _editor.get_selection().remove (this);
 382
 383         Hiding ();
 384 }
 385
 386 void
 387 TimeAxisView::step_height (bool bigger)
 388 {
 389         static const uint32_t step = 20;
 390
 391         if (bigger) {
 392                 set_height (height + step);
 393         } else {
 394                 if (height > step) {
 395                         set_height (std::max (height - step, hSmall));
 396                 } else if (height != hSmall) {
 397                         set_height (hSmall);
 398                 }
 399         }
 400 }
 401
 402 void
 403 TimeAxisView::set_heights (uint32_t h)
 404 {
 405         TrackSelection& ts (_editor.get_selection().tracks);
 406
 407         for (TrackSelection::iterator i = ts.begin(); i != ts.end(); ++i) {
 408                 (*i)->set_height (h);
 409         }
 410 }
 411
 412 void
 413 TimeAxisView::set_height(uint32_t h)
 414 {
 415         controls_ebox.property_height_request () = h;
 416         height = h;
 417
 418         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 419                 (*i)->set_height ();
 420         }
 421
 422         if (canvas_item_visible (selection_group)) {
 423                 /* resize the selection rect */
 424                 show_selection (_editor.get_selection().time);
 425         }
 426
 427         reshow_feature_lines ();
 428 }
 429
 430 bool
 431 TimeAxisView::name_entry_key_release (GdkEventKey* ev)
 432 {
 433         TrackViewList::iterator i;
 434
 435         switch (ev->keyval) {
 436         case GDK_Escape:
 437                 name_entry.select_region (0,0);
 438                 controls_ebox.grab_focus ();
 439                 name_entry_changed ();
 440                 return true;
 441
 442         /* Shift+Tab Keys Pressed. Note that for Shift+Tab, GDK actually
 443          * generates a different ev->keyval, rather than setting
 444          * ev->state.
 445          */
 446         case GDK_ISO_Left_Tab:
 447         case GDK_Tab:
 448         {
 449                 name_entry_changed ();
 450                 TrackViewList const & allviews = _editor.get_track_views ();
 451                 TrackViewList::const_iterator i = find (allviews.begin(), allviews.end(), this);
 452                 if (ev->keyval == GDK_Tab) {
 453                         if (i != allviews.end()) {
 454                                 do {
 455                                         if (++i == allviews.end()) {
 456                                                 return true;
 457                                         }
 458                                 } while((*i)->hidden());
 459                         }
 460                 } else {
 461                         if (i != allviews.begin()) {
 462                                 do {
 463                                         if (i == allviews.begin()) {
 464                                                 return true;
 465                                         }
 466                                         --i;
 467                                 } while ((*i)->hidden());
 468                         }
 469                 }
 470
 471
 472                 /* resize to show editable name display */
 473
 474                 if ((*i)->current_height() <= hSmaller) {
 475                         (*i)->set_height (hSmaller);
 476                 }
 477
 478                 (*i)->name_entry.grab_focus();
 479         }
 480         return true;
 481
 482         case GDK_Up:
 483         case GDK_Down:
 484                 name_entry_changed ();
 485                 return true;
 486
 487         default:
 488                 break;
 489         }
 490
 491 #ifdef TIMEOUT_NAME_EDIT
 492         /* adapt the timeout to reflect the user's typing speed */
 493
 494         guint32 name_entry_timeout;
 495
 496         if (last_name_entry_key_press_event) {
 497                 /* timeout is 1/2 second or 5 times their current inter-char typing speed */
 498                 name_entry_timeout = std::max (500U, (5 * (ev->time - last_name_entry_key_press_event)));
 499         } else {
 500                 /* start with a 1 second timeout */
 501                 name_entry_timeout = 1000;
 502         }
 503
 504         last_name_entry_key_press_event = ev->time;
 505
 506         /* wait 1 seconds and if no more keys are pressed, act as if they pressed enter */
 507
 508         name_entry_key_timeout.disconnect();
 509         name_entry_key_timeout = Glib::signal_timeout().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_timed_out), name_entry_timeout);
 510 #endif
 511
 512         return false;
 513 }
 514
 515 bool
 516 TimeAxisView::name_entry_focus_in (GdkEventFocus*)
 517 {
 518         name_entry.select_region (0, -1);
 519         name_entry.set_name ("EditorActiveTrackNameDisplay");
 520         return false;
 521 }
 522
 523 bool
 524 TimeAxisView::name_entry_focus_out (GdkEventFocus*)
 525 {
 526         /* clean up */
 527
 528         last_name_entry_key_press_event = 0;
 529         name_entry_key_timeout.disconnect ();
 530         name_entry.set_name ("EditorTrackNameDisplay");
 531         name_entry.select_region (0,0);
 532
 533         /* do the real stuff */
 534
 535         name_entry_changed ();
 536
 537         return false;
 538 }
 539
 540 bool
 541 TimeAxisView::name_entry_key_timed_out ()
 542 {
 543         name_entry_activated();
 544         return false;
 545 }
 546
 547 void
 548 TimeAxisView::name_entry_activated ()
 549 {
 550         controls_ebox.grab_focus();
 551 }
 552
 553 void
 554 TimeAxisView::name_entry_changed ()
 555 {
 556 }
 557
 558 bool
 559 TimeAxisView::name_entry_button_press (GdkEventButton *ev)
 560 {
 561         if (ev->button == 3) {
 562                 return true;
 563         }
 564         return false;
 565 }
 566
 567 bool
 568 TimeAxisView::name_entry_button_release (GdkEventButton *ev)
 569 {
 570         if (ev->button == 3) {
 571                 popup_display_menu (ev->time);
 572                 return true;
 573         }
 574         return false;
 575 }
 576
 577 void
 578 TimeAxisView::conditionally_add_to_selection ()
 579 {
 580         Selection& s (_editor.get_selection ());
 581
 582         if (!s.selected (this)) {
 583                 _editor.set_selected_track (*this, Selection::Set);
 584         }
 585 }
 586
 587 void
 588 TimeAxisView::popup_display_menu (guint32 when)
 589 {
 590         if (display_menu == 0) {
 591                 build_display_menu ();
 592         }
 593
 594         conditionally_add_to_selection ();
 595         display_menu->popup (1, when);
 596 }
 597
 598 gint
 599 TimeAxisView::size_click (GdkEventButton *ev)
 600 {
 601         conditionally_add_to_selection ();
 602         popup_size_menu (ev->time);
 603         return TRUE;
 604 }
 605
 606 void
 607 TimeAxisView::popup_size_menu (guint32 when)
 608 {
 609         if (size_menu == 0) {
 610                 build_size_menu ();
 611         }
 612         size_menu->popup (1, when);
 613 }
 614
 615 void
 616 TimeAxisView::set_selected (bool yn)
 617 {
 618         if (yn == _selected) {
 619                 return;
 620         }
 621
 622         Selectable::set_selected (yn);
 623
 624         if (_selected) {
 625                 controls_ebox.set_name (controls_base_selected_name);
 626                 controls_hbox.set_name (controls_base_selected_name);
 627                 controls_vbox.set_name (controls_base_selected_name);
 628         } else {
 629                 controls_ebox.set_name (controls_base_unselected_name);
 630                 controls_hbox.set_name (controls_base_unselected_name);
 631                 controls_vbox.set_name (controls_base_unselected_name);
 632                 hide_selection ();
 633
 634                 /* children will be set for the yn=true case. but when deselecting
 635                    the editor only has a list of top-level trackviews, so we
 636                    have to do this here.
 637                 */
 638
 639                 for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 640                         (*i)->set_selected (false);
 641                 }
 642         }
 643
 644         resizer.queue_draw ();
 645 }
 646
 647 void
 648 TimeAxisView::build_size_menu ()
 649 {
 650         using namespace Menu_Helpers;
 651
 652         size_menu = new Menu;
 653         size_menu->set_name ("ArdourContextMenu");
 654         MenuList& items = size_menu->items();
 655
 656         items.push_back (MenuElem (_("Largest"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights), hLargest)));
 657         items.push_back (MenuElem (_("Large"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights), hLarge)));
 658         items.push_back (MenuElem (_("Larger"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights), hLarger)));
 659         items.push_back (MenuElem (_("Normal"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights), hNormal)));
 660         items.push_back (MenuElem (_("Smaller"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights),hSmaller)));
 661         items.push_back (MenuElem (_("Small"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_heights), hSmall)));
 662 }
 663
 664 void
 665 TimeAxisView::build_display_menu ()
 666 {
 667         using namespace Menu_Helpers;
 668
 669         delete display_menu;
 670
 671         display_menu = new Menu;
 672         display_menu->set_name ("ArdourContextMenu");
 673
 674         // Just let implementing classes define what goes into the manu
 675 }
 676
 677 void
 678 TimeAxisView::set_samples_per_unit (double spu)
 679 {
 680         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 681                 (*i)->set_samples_per_unit (spu);
 682         }
 683
 684         AnalysisFeatureList::const_iterator i;
 685         list<ArdourCanvas::SimpleLine*>::iterator l;
 686
 687         for (i = analysis_features.begin(), l = feature_lines.begin(); i != analysis_features.end() && l != feature_lines.end(); ++i, ++l) {
 688                 (*l)->property_x1() = _editor.frame_to_pixel (*i);
 689                 (*l)->property_x2() = _editor.frame_to_pixel (*i);
 690         }
 691 }
 692
 693 void
 694 TimeAxisView::show_timestretch (nframes_t start, nframes_t end)
 695 {
 696         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 697                 (*i)->show_timestretch (start, end);
 698         }
 699 }
 700
 701 void
 702 TimeAxisView::hide_timestretch ()
 703 {
 704         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 705                 (*i)->hide_timestretch ();
 706         }
 707 }
 708
 709 void
 710 TimeAxisView::show_selection (TimeSelection& ts)
 711 {
 712         double x1;
 713         double x2;
 714         double y2;
 715         SelectionRect *rect;
 716
 717         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 718                 (*i)->show_selection (ts);
 719         }
 720
 721         if (canvas_item_visible (selection_group)) {
 722                 while (!used_selection_rects.empty()) {
 723                         free_selection_rects.push_front (used_selection_rects.front());
 724                         used_selection_rects.pop_front();
 725                         free_selection_rects.front()->rect->hide();
 726                         free_selection_rects.front()->start_trim->hide();
 727                         free_selection_rects.front()->end_trim->hide();
 728                 }
 729                 selection_group->hide();
 730         }
 731
 732         selection_group->show();
 733         selection_group->raise_to_top();
 734
 735         for (list<AudioRange>::iterator i = ts.begin(); i != ts.end(); ++i) {
 736                 nframes_t start, end, cnt;
 737
 738                 start = (*i).start;
 739                 end = (*i).end;
 740                 cnt = end - start + 1;
 741
 742                 rect = get_selection_rect ((*i).id);
 743
 744                 x1 = _editor.frame_to_unit (start);
 745                 x2 = _editor.frame_to_unit (start + cnt - 1);
 746                 y2 = current_height();
 747
 748                 rect->rect->property_x1() = x1;
 749                 rect->rect->property_y1() = 1.0;
 750                 rect->rect->property_x2() = x2;
 751                 rect->rect->property_y2() = y2;
 752
 753                 // trim boxes are at the top for selections
 754
 755                 if (x2 > x1) {
 756                         rect->start_trim->property_x1() = x1;
 757                         rect->start_trim->property_y1() = 1.0;
 758                         rect->start_trim->property_x2() = x1 + trim_handle_size;
 759                         rect->start_trim->property_y2() = 1.0 + trim_handle_size;
 760
 761                         rect->end_trim->property_x1() = x2 - trim_handle_size;
 762                         rect->end_trim->property_y1() = 1.0;
 763                         rect->end_trim->property_x2() = x2;
 764                         rect->end_trim->property_y2() = 1.0 + trim_handle_size;
 765
 766                         rect->start_trim->show();
 767                         rect->end_trim->show();
 768                 } else {
 769                         rect->start_trim->hide();
 770                         rect->end_trim->hide();
 771                 }
 772
 773                 rect->rect->show ();
 774                 used_selection_rects.push_back (rect);
 775         }
 776 }
 777
 778 void
 779 TimeAxisView::reshow_selection (TimeSelection& ts)
 780 {
 781         show_selection (ts);
 782
 783         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 784                 (*i)->show_selection (ts);
 785         }
 786 }
 787
 788 void
 789 TimeAxisView::hide_selection ()
 790 {
 791         if (canvas_item_visible (selection_group)) {
 792                 while (!used_selection_rects.empty()) {
 793                         free_selection_rects.push_front (used_selection_rects.front());
 794                         used_selection_rects.pop_front();
 795                         free_selection_rects.front()->rect->hide();
 796                         free_selection_rects.front()->start_trim->hide();
 797                         free_selection_rects.front()->end_trim->hide();
 798                 }
 799                 selection_group->hide();
 800         }
 801
 802         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 803                 (*i)->hide_selection ();
 804         }
 805 }
 806
 807 void
 808 TimeAxisView::order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top)
 809 {
 810         /* find the selection rect this is for. we have the item corresponding to one
 811            of the trim handles.
 812          */
 813
 814         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 815                 if ((*i)->start_trim == item || (*i)->end_trim == item) {
 816
 817                         /* make one trim handle be "above" the other so that if they overlap,
 818                            the top one is the one last used.
 819                         */
 820
 821                         (*i)->rect->raise_to_top ();
 822                         (put_start_on_top ? (*i)->start_trim : (*i)->end_trim)->raise_to_top ();
 823                         (put_start_on_top ? (*i)->end_trim : (*i)->start_trim)->raise_to_top ();
 824
 825                         break;
 826                 }
 827         }
 828 }
 829
 830 SelectionRect *
 831 TimeAxisView::get_selection_rect (uint32_t id)
 832 {
 833         SelectionRect *rect;
 834
 835         /* check to see if we already have a visible rect for this particular selection ID */
 836
 837         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 838                 if ((*i)->id == id) {
 839                         return (*i);
 840                 }
 841         }
 842
 843         /* ditto for the free rect list */
 844
 845         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 846                 if ((*i)->id == id) {
 847                         SelectionRect* ret = (*i);
 848                         free_selection_rects.erase (i);
 849                         return ret;
 850                 }
 851         }
 852
 853         /* no existing matching rect, so go get a new one from the free list, or create one if there are none */
 854
 855         if (free_selection_rects.empty()) {
 856
 857                 rect = new SelectionRect;
 858
 859                 rect->rect = new SimpleRect (*selection_group);
 860                 rect->rect->property_x1() = 0.0;
 861                 rect->rect->property_y1() = 0.0;
 862                 rect->rect->property_x2() = 0.0;
 863                 rect->rect->property_y2() = 0.0;
 864                 rect->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
 865                 rect->rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
 866
 867                 rect->start_trim = new SimpleRect (*selection_group);
 868                 rect->start_trim->property_x1() = 0.0;
 869                 rect->start_trim->property_x2() = 0.0;
 870                 rect->start_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
 871                 rect->start_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
 872
 873                 rect->end_trim = new SimpleRect (*selection_group);
 874                 rect->end_trim->property_x1() = 0.0;
 875                 rect->end_trim->property_x2() = 0.0;
 876                 rect->end_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
 877                 rect->end_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
 878
 879                 free_selection_rects.push_front (rect);
 880
 881                 rect->rect->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_rect_event), rect->rect, rect));
 882                 rect->start_trim->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_start_trim_event), rect->rect, rect));
 883                 rect->end_trim->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_end_trim_event), rect->rect, rect));
 884         }
 885
 886         rect = free_selection_rects.front();
 887         rect->id = id;
 888         free_selection_rects.pop_front();
 889         return rect;
 890 }
 891
 892 struct null_deleter { void operator()(void const *) const {} };
 893
 894 bool
 895 TimeAxisView::is_child (TimeAxisView* tav)
 896 {
 897         return find (children.begin(), children.end(), boost::shared_ptr<TimeAxisView>(tav, null_deleter())) != children.end();
 898 }
 899
 900 void
 901 TimeAxisView::add_child (boost::shared_ptr<TimeAxisView> child)
 902 {
 903         children.push_back (child);
 904 }
 905
 906 void
 907 TimeAxisView::remove_child (boost::shared_ptr<TimeAxisView> child)
 908 {
 909         Children::iterator i;
 910
 911         if ((i = find (children.begin(), children.end(), child)) != children.end()) {
 912                 children.erase (i);
 913         }
 914 }
 915
 916 void
 917 TimeAxisView::get_selectables (nframes_t /*start*/, nframes_t /*end*/, double /*top*/, double /*bot*/, list<Selectable*>& /*result*/)
 918 {
 919         return;
 920 }
 921
 922 void
 923 TimeAxisView::get_inverted_selectables (Selection& /*sel*/, list<Selectable*>& /*result*/)
 924 {
 925         return;
 926 }
 927
 928 void
 929 TimeAxisView::add_ghost (RegionView* rv)
 930 {
 931         GhostRegion* gr = rv->add_ghost (*this);
 932
 933         if(gr) {
 934                 ghosts.push_back(gr);
 935         }
 936 }
 937
 938 void
 939 TimeAxisView::remove_ghost (RegionView* rv)
 940 {
 941         rv->remove_ghost_in (*this);
 942 }
 943
 944 void
 945 TimeAxisView::erase_ghost (GhostRegion* gr)
 946 {
 947         if (in_destructor) {
 948                 return;
 949         }
 950
 951         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 952                 if ((*i) == gr) {
 953                         ghosts.erase (i);
 954                         break;
 955                 }
 956         }
 957 }
 958
 959 bool
 960 TimeAxisView::touched (double top, double bot)
 961 {
 962         /* remember: this is X Window - coordinate space starts in upper left and moves down.
 963           y_position is the "origin" or "top" of the track.
 964         */
 965
 966         double mybot = _y_position + current_height();
 967
 968         return ((_y_position <= bot && _y_position >= top) ||
 969                 ((mybot <= bot) && (top < mybot)) ||
 970                 (mybot >= bot && _y_position < top));
 971 }
 972
 973 void
 974 TimeAxisView::set_parent (TimeAxisView& p)
 975 {
 976         parent = &p;
 977 }
 978
 979 bool
 980 TimeAxisView::has_state () const
 981 {
 982         return _has_state;
 983 }
 984
 985 TimeAxisView*
 986 TimeAxisView::get_parent_with_state ()
 987 {
 988         if (parent == 0) {
 989                 return 0;
 990         }
 991
 992         if (parent->has_state()) {
 993                 return parent;
 994         }
 995
 996         return parent->get_parent_with_state ();
 997 }
 998
 999
1000 XMLNode&
1001 TimeAxisView::get_state ()
1002 {
1003         XMLNode* node = new XMLNode ("TAV-" + name());
1004         char buf[32];
1005
1006         snprintf (buf, sizeof(buf), "%u", height);
1007         node->add_property ("height", buf);
1008         node->add_property ("marked-for-display", (_marked_for_display ? "1" : "0"));
1009         return *node;
1010 }
1011
1012 int
1013 TimeAxisView::set_state (const XMLNode& node, int /*version*/)
1014 {
1015         const XMLProperty *prop;
1016
1017         if ((prop = node.property ("marked-for-display")) != 0) {
1018                 _marked_for_display = (prop->value() == "1");
1019         }
1020
1021         if ((prop = node.property ("track-height")) != 0) {
1022
1023                 if (prop->value() == "largest") {
1024                         set_height (hLargest);
1025                 } else if (prop->value() == "large") {
1026                         set_height (hLarge);
1027                 } else if (prop->value() == "larger") {
1028                         set_height (hLarger);
1029                 } else if (prop->value() == "normal") {
1030                         set_height (hNormal);
1031                 } else if (prop->value() == "smaller") {
1032                         set_height (hSmaller);
1033                 } else if (prop->value() == "small") {
1034                         set_height (hSmall);
1035                 } else {
1036                         error << string_compose(_("unknown track height name \"%1\" in XML GUI information"), prop->value()) << endmsg;
1037                         set_height (Normal);
1038                 }
1039
1040         } else if ((prop = node.property ("height")) != 0) {
1041
1042                 set_height (atoi (prop->value()));
1043
1044         } else {
1045
1046                 set_height (hNormal);
1047         }
1048
1049         return 0;
1050 }
1051
1052 void
1053 TimeAxisView::reset_height()
1054 {
1055         set_height (height);
1056
1057         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
1058                 (*i)->set_height ((*i)->height);
1059         }
1060 }
1061
1062 void
1063 TimeAxisView::compute_controls_size_info ()
1064 {
1065         Gtk::Window window (Gtk::WINDOW_TOPLEVEL);
1066         Gtk::Table two_row_table (2, 8);
1067         Gtk::Table one_row_table (1, 8);
1068         Button* buttons[5];
1069         const int border_width = 2;
1070         const int extra_height = (2 * border_width)
1071                 //+ 2   // 2 pixels for the hseparator between TimeAxisView control areas
1072                 + 10; // resizer button (3 x 2 pixel elements + 2 x 2 pixel gaps)
1073
1074         window.add (one_row_table);
1075
1076         one_row_table.set_border_width (border_width);
1077         one_row_table.set_row_spacings (0);
1078         one_row_table.set_col_spacings (0);
1079         one_row_table.set_homogeneous (true);
1080
1081         two_row_table.set_border_width (border_width);
1082         two_row_table.set_row_spacings (0);
1083         two_row_table.set_col_spacings (0);
1084         two_row_table.set_homogeneous (true);
1085
1086         for (int i = 0; i < 5; ++i) {
1087                 buttons[i] = manage (new Button (X_("f")));
1088                 buttons[i]->set_name ("TrackMuteButton");
1089         }
1090
1091         one_row_table.attach (*buttons[0], 6, 7, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1092
1093         one_row_table.show_all ();
1094         Gtk::Requisition req(one_row_table.size_request ());
1095
1096
1097         // height required to show 1 row of buttons
1098
1099         hSmaller = req.height + extra_height;
1100
1101         window.remove ();
1102         window.add (two_row_table);
1103
1104         two_row_table.attach (*buttons[1], 5, 6, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1105         two_row_table.attach (*buttons[2], 6, 7, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1106         two_row_table.attach (*buttons[3], 7, 8, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1107         two_row_table.attach (*buttons[4], 8, 9, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1108
1109         two_row_table.show_all ();
1110         req = two_row_table.size_request ();
1111
1112         // height required to show all normal buttons
1113
1114         hNormal = /*req.height*/ 48 + extra_height;
1115
1116         // these heights are all just larger than normal. no more
1117         // elements are visible (yet).
1118
1119         hLarger = hNormal + 50;
1120         hLarge = hNormal + 150;
1121         hLargest = hNormal + 250;
1122
1123         // height required to show track name
1124
1125         hSmall = 27;
1126 }
1127
1128 void
1129 TimeAxisView::show_name_label ()
1130 {
1131         if (!(name_packing & NameLabelPacked)) {
1132                 name_hbox.pack_start (name_label, true, true);
1133                 name_packing = NamePackingBits (name_packing | NameLabelPacked);
1134                 name_hbox.show ();
1135                 name_label.show ();
1136         }
1137 }
1138
1139 void
1140 TimeAxisView::show_name_entry ()
1141 {
1142         if (!(name_packing & NameEntryPacked)) {
1143                 name_hbox.pack_start (name_entry, true, true);
1144                 name_packing = NamePackingBits (name_packing | NameEntryPacked);
1145                 name_hbox.show ();
1146                 name_entry.show ();
1147         }
1148 }
1149
1150 void
1151 TimeAxisView::hide_name_label ()
1152 {
1153         if (name_packing & NameLabelPacked) {
1154                 name_hbox.remove (name_label);
1155                 name_packing = NamePackingBits (name_packing & ~NameLabelPacked);
1156         }
1157 }
1158
1159 void
1160 TimeAxisView::hide_name_entry ()
1161 {
1162         if (name_packing & NameEntryPacked) {
1163                 name_hbox.remove (name_entry);
1164                 name_packing = NamePackingBits (name_packing & ~NameEntryPacked);
1165         }
1166 }
1167
1168 void
1169 TimeAxisView::color_handler ()
1170 {
1171         for (list<GhostRegion*>::iterator i=ghosts.begin(); i != ghosts.end(); i++ ) {
1172                 (*i)->set_colors();
1173         }
1174
1175         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
1176
1177                 (*i)->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
1178                 (*i)->rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1179
1180                 (*i)->start_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1181                 (*i)->start_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1182
1183                 (*i)->end_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1184                 (*i)->end_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1185         }
1186
1187         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
1188
1189                 (*i)->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
1190                 (*i)->rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1191
1192                 (*i)->start_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1193                 (*i)->start_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1194
1195                 (*i)->end_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1196                 (*i)->end_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1197         }
1198 }
1199
1200 /** @return Pair: TimeAxisView, layer index.
1201  * TimeAxisView is non-0 if this object covers y, or one of its children does.
1202  * If the covering object is a child axis, then the child is returned.
1203  * TimeAxisView is 0 otherwise.
1204  * Layer index is the layer number if the TimeAxisView is valid and is in stacked
1205  * region display mode, otherwise 0.
1206  */
1207 std::pair<TimeAxisView*, layer_t>
1208 TimeAxisView::covers_y_position (double y)
1209 {
1210         if (hidden()) {
1211                 return std::make_pair ( (TimeAxisView *) 0, 0);
1212         }
1213
1214         if (_y_position <= y && y < (_y_position + height)) {
1215
1216                 /* work out the layer index if appropriate */
1217                 layer_t l = 0;
1218                 if (layer_display () == Stacked && view ()) {
1219                         /* compute layer */
1220                         l = layer_t ((_y_position + height - y) / (view()->child_height ()));
1221                         /* clamp to max layers to be on the safe side; sometimes the above calculation
1222                           returns a too-high value */
1223                         if (l >= view()->layers ()) {
1224                                 l = view()->layers() - 1;
1225                         }
1226                 }
1227
1228                 return std::make_pair (this, l);
1229         }
1230
1231         for (Children::const_iterator i = children.begin(); i != children.end(); ++i) {
1232
1233                 std::pair<TimeAxisView*, int> const r = (*i)->covers_y_position (y);
1234                 if (r.first) {
1235                         return r;
1236                 }
1237         }
1238
1239         return std::make_pair ( (TimeAxisView *) 0, 0);
1240 }
1241
1242 void
1243 TimeAxisView::show_feature_lines (const AnalysisFeatureList& pos)
1244 {
1245         analysis_features = pos;
1246         reshow_feature_lines ();
1247 }
1248
1249
1250 void
1251 TimeAxisView::hide_feature_lines ()
1252 {
1253         list<ArdourCanvas::SimpleLine*>::iterator l;
1254
1255         for (l = feature_lines.begin(); l != feature_lines.end(); ++l) {
1256                 (*l)->hide();
1257         }
1258 }
1259
1260 void
1261 TimeAxisView::reshow_feature_lines ()
1262 {
1263         while (feature_lines.size()< analysis_features.size()) {
1264                 ArdourCanvas::SimpleLine* l = new ArdourCanvas::SimpleLine (*_canvas_display);
1265                 l->property_color_rgba() = (guint) ARDOUR_UI::config()->canvasvar_ZeroLine.get();
1266                 feature_lines.push_back (l);
1267         }
1268
1269         while (feature_lines.size() > analysis_features.size()) {
1270                 ArdourCanvas::SimpleLine *line = feature_lines.back();
1271                 feature_lines.pop_back ();
1272                 delete line;
1273         }
1274
1275         AnalysisFeatureList::const_iterator i;
1276         list<ArdourCanvas::SimpleLine*>::iterator l;
1277
1278         for (i = analysis_features.begin(), l = feature_lines.begin(); i != analysis_features.end() && l != feature_lines.end(); ++i, ++l) {
1279                 (*l)->property_x1() = _editor.frame_to_pixel (*i);
1280                 (*l)->property_x2() = _editor.frame_to_pixel (*i);
1281                 (*l)->property_y1() = 0;
1282                 (*l)->property_y2() = current_height();
1283                 (*l)->show ();
1284         }
1285 }
1286
1287 bool
1288 TimeAxisView::resizer_button_press (GdkEventButton* event)
1289 {
1290         _resize_drag_start = event->y_root;
1291         return true;
1292 }
1293
1294 bool
1295 TimeAxisView::resizer_button_release (GdkEventButton*)
1296 {
1297         _resize_drag_start = -1;
1298         return true;
1299 }
1300
1301 void
1302 TimeAxisView::idle_resize (uint32_t h)
1303 {
1304         set_height (h);
1305 }
1306
1307 bool
1308 TimeAxisView::resizer_motion (GdkEventMotion* ev)
1309 {
1310         if (_resize_drag_start < 0) {
1311                 return true;
1312         }
1313
1314         int32_t const delta = (int32_t) floor (ev->y_root - _resize_drag_start);
1315         _editor.add_to_idle_resize (this, delta);
1316         _resize_drag_start = ev->y_root;
1317
1318         return true;
1319 }
1320
1321 bool
1322 TimeAxisView::resizer_expose (GdkEventExpose* event)
1323 {
1324         int w, h, x, y, d;
1325         Glib::RefPtr<Gdk::Window> win (resizer.get_window());
1326         Glib::RefPtr<Gdk::GC> dark (resizer.get_style()->get_fg_gc (STATE_NORMAL));
1327         Glib::RefPtr<Gdk::GC> light (resizer.get_style()->get_bg_gc (STATE_NORMAL));
1328
1329         win->draw_rectangle (controls_ebox.get_style()->get_bg_gc(STATE_NORMAL),
1330                         true,
1331                         event->area.x,
1332                         event->area.y,
1333                         event->area.width,
1334                         event->area.height);
1335
1336         win->get_geometry (x, y, w, h, d);
1337
1338         /* handle/line #1 */
1339
1340         win->draw_line (dark, 0, 0, w - 2, 0);
1341         win->draw_point (dark, 0, 1);
1342         win->draw_line (light, 1, 1, w - 1, 1);
1343         win->draw_point (light, w - 1, 0);
1344
1345         /* handle/line #2 */
1346
1347         win->draw_line (dark, 0, 4, w - 2, 4);
1348         win->draw_point (dark, 0, 5);
1349         win->draw_line (light, 1, 5, w - 1, 5);
1350         win->draw_point (light, w - 1, 4);
1351
1352         /* handle/line #3 */
1353
1354         win->draw_line (dark, 0, 8, w - 2, 8);
1355         win->draw_point (dark, 0, 9);
1356         win->draw_line (light, 1, 9, w - 1, 9);
1357         win->draw_point (light, w - 1, 8);
1358
1359         /* use vertical resize mouse cursor */
1360         win->set_cursor(Gdk::Cursor(Gdk::SB_V_DOUBLE_ARROW));
1361
1362         return true;
1363 }
1364
1365 bool
1366 TimeAxisView::set_visibility (bool yn)
1367 {
1368         if (yn != marked_for_display()) {
1369                 if (yn) {
1370                         set_marked_for_display (true);
1371                         canvas_display()->show();
1372                 } else {
1373                         set_marked_for_display (false);
1374                         hide ();
1375                 }
1376                 return true; // things changed
1377         }
1378
1379         return false;
1380 }