X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fcanvas%2Fcanvas.cc;h=eb18899ab3b446bc44f8df51ae680dcec3873e0f;hb=2abd8b8f06e6887f1907074a5ae53a5cdb77f2f2;hp=3d4f9e0c5df633d0eb71f609ef01fe336c17643c;hpb=47efeb9f21c936cf2767ea3099e3fe711ff80334;p=ardour.git diff --git a/libs/canvas/canvas.cc b/libs/canvas/canvas.cc index 3d4f9e0c5d..eb18899ab3 100644 --- a/libs/canvas/canvas.cc +++ b/libs/canvas/canvas.cc @@ -26,21 +26,27 @@ #include #include #include +#include #include "pbd/compose.h" #include "pbd/stacktrace.h" #include "canvas/canvas.h" +#include "canvas/colors.h" #include "canvas/debug.h" #include "canvas/line.h" #include "canvas/scroll_group.h" +#include "canvas/utils.h" using namespace std; using namespace ArdourCanvas; +uint32_t Canvas::tooltip_timeout_msecs = 750; + /** Construct a new Canvas */ Canvas::Canvas () : _root (this) + , _bg_color (rgba_to_color (0, 1.0, 0.0, 1.0)) { set_epoch (); } @@ -110,16 +116,17 @@ Canvas::render (Rect const & area, Cairo::RefPtr const & context _root.render (*draw, context); -#if 0 - // This transparently colors the rect being rendered, after it has been drawn. - double r = (random() % 65536) /65536.0; - double g = (random() % 65536) /65536.0; - double b = (random() % 65536) /65536.0; - context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0); - context->set_source_rgba (r, g, b, 0.25); - context->fill (); +#if defined CANVAS_DEBUG && !PLATFORM_WINDOWS + if (getenv ("CANVAS_HARLEQUIN_DEBUGGING")) { + // This transparently colors the rect being rendered, after it has been drawn. + double r = (random() % 65536) /65536.0; + double g = (random() % 65536) /65536.0; + double b = (random() % 65536) /65536.0; + context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0); + context->set_source_rgba (r, g, b, 0.25); + context->fill (); + } #endif - } } @@ -170,7 +177,9 @@ Canvas::item_shown_or_hidden (Item* item) { boost::optional bbox = item->bounding_box (); if (bbox) { - queue_draw_item_area (item, bbox.get ()); + if (item->item_to_window (*bbox).intersection (visible_area ())) { + queue_draw_item_area (item, bbox.get ()); + } } } @@ -183,7 +192,9 @@ Canvas::item_visual_property_changed (Item* item) { boost::optional bbox = item->bounding_box (); if (bbox) { - queue_draw_item_area (item, bbox.get ()); + if (item->item_to_window (*bbox).intersection (visible_area ())) { + queue_draw_item_area (item, bbox.get ()); + } } } @@ -195,15 +206,24 @@ Canvas::item_visual_property_changed (Item* item) void Canvas::item_changed (Item* item, boost::optional pre_change_bounding_box) { + + Rect window_bbox = visible_area (); + if (pre_change_bounding_box) { - /* request a redraw of the item's old bounding box */ - queue_draw_item_area (item, pre_change_bounding_box.get ()); + + if (item->item_to_window (*pre_change_bounding_box).intersection (window_bbox)) { + /* request a redraw of the item's old bounding box */ + queue_draw_item_area (item, pre_change_bounding_box.get ()); + } } boost::optional post_change_bounding_box = item->bounding_box (); if (post_change_bounding_box) { - /* request a redraw of the item's new bounding box */ - queue_draw_item_area (item, post_change_bounding_box.get ()); + + if (item->item_to_window (*post_change_bounding_box).intersection (window_bbox)) { + /* request a redraw of the item's new bounding box */ + queue_draw_item_area (item, post_change_bounding_box.get ()); + } } } @@ -218,8 +238,21 @@ Canvas::window_to_canvas (Duple const & d) const std::list const& root_children (_root.items()); ScrollGroup* sg = 0; + /* if the coordinates are negative, clamp to zero and find the item + * that covers that "edge" position. + */ + + Duple in_window (d); + + if (in_window.x < 0) { + in_window.x = 0; + } + if (in_window.y < 0) { + in_window.y = 0; + } + for (std::list::const_iterator i = root_children.begin(); i != root_children.end(); ++i) { - if (((sg = dynamic_cast(*i)) != 0) && sg->covers_window (d)) { + if (((sg = dynamic_cast(*i)) != 0) && sg->covers_window (in_window)) { break; } } @@ -304,16 +337,45 @@ Canvas::queue_draw_item_area (Item* item, Rect area) request_redraw (item->item_to_window (area)); } +void +Canvas::set_tooltip_timeout (uint32_t msecs) +{ + tooltip_timeout_msecs = msecs; +} + +void +Canvas::set_background_color (Color c) +{ + _bg_color = c; + + boost::optional r = _root.bounding_box(); + + if (r) { + request_redraw (_root.item_to_window (r.get())); + } +} + +void +GtkCanvas::re_enter () +{ + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, "re-enter canvas by request\n"); + _current_item = 0; + pick_current_item (0); +} + /** Construct a GtkCanvas */ GtkCanvas::GtkCanvas () : _current_item (0) , _new_current_item (0) , _grabbed_item (0) , _focused_item (0) + , current_tooltip_item (0) + , tooltip_window (0) { /* these are the events we want to know about */ add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK | - Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK); + Gdk::SCROLL_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK | + Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK); } void @@ -360,9 +422,9 @@ GtkCanvas::pick_current_item (Duple const & point, int state) if (DEBUG_ENABLED(PBD::DEBUG::CanvasEnterLeave)) { for (vector::const_iterator it = items.begin(); it != items.end(); ++it) { #ifdef CANVAS_DEBUG - std::cerr << "\tItem " << (*it)->whatami() << '/' << (*it)->name << std::endl; + std::cerr << "\tItem " << (*it)->whatami() << '/' << (*it)->name << " ignore events ? " << (*it)->ignore_events() << " vis ? " << (*it)->visible() << std::endl; #else - std::cerr << "\tItem " << (*it)->whatami() << std::endl; + std::cerr << "\tItem " << (*it)->whatami() << '/' << " ignore events ? " << (*it)->ignore_events() << " vis ? " << (*it)->visible() << std::endl; #endif } } @@ -379,17 +441,18 @@ GtkCanvas::pick_current_item (Duple const & point, int state) for (i = items.begin(); i != items.end(); ++i) { - Item const * new_item = *i; + Item const * possible_item = *i; - /* We ignore invisible items, groups and items that ignore events */ + /* We ignore invisible items, containers and items that ignore events */ - if (!new_item->visible() || new_item->ignore_events() || dynamic_cast(new_item) != 0) { + if (!possible_item->visible() || possible_item->ignore_events() || dynamic_cast(possible_item) != 0) { continue; } - - within_items.push_front (new_item); + within_items.push_front (possible_item); } + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("after filtering insensitive + containers, we have %1 items\n", within_items.size())); + if (within_items.empty()) { /* no items at point, just send leave event below */ @@ -399,6 +462,7 @@ GtkCanvas::pick_current_item (Duple const & point, int state) if (within_items.front() == _current_item) { /* uppermost item at point is already _current_item */ + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("CURRENT ITEM %1/%2\n", _new_current_item->whatami(), _current_item->name)); return; } @@ -408,6 +472,13 @@ GtkCanvas::pick_current_item (Duple const & point, int state) if (_new_current_item != _current_item) { deliver_enter_leave (point, state); } + + if (_current_item) { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("CURRENT ITEM %1/%2\n", _new_current_item->whatami(), _current_item->name)); + } else { + DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, "--- no current item\n"); + } + } /** Deliver a series of enter & leave events based on the pointer position being at window @@ -418,9 +489,15 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state) { /* setup enter & leave event structures */ + Glib::RefPtr win = get_window(); + + if (!win) { + return; + } + GdkEventCrossing enter_event; enter_event.type = GDK_ENTER_NOTIFY; - enter_event.window = get_window()->gobj(); + enter_event.window = win->gobj(); enter_event.send_event = 0; enter_event.subwindow = 0; enter_event.mode = GDK_CROSSING_NORMAL; @@ -439,8 +516,8 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state) leave_event.type = GDK_LEAVE_NOTIFY; Item* i; - GdkNotifyType enter_detail; - GdkNotifyType leave_detail; + GdkNotifyType enter_detail = GDK_NOTIFY_UNKNOWN; + GdkNotifyType leave_detail = GDK_NOTIFY_UNKNOWN; vector items_to_leave_virtual; vector items_to_enter_virtual; @@ -487,7 +564,6 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state) enter_detail = GDK_NOTIFY_INFERIOR; leave_detail = GDK_NOTIFY_ANCESTOR; - } else if (_new_current_item->is_descendant_of (*_current_item)) { /* move from ancestor to descendant (X: "_new_current_item is * an inferior ("child") of _current_item") @@ -555,6 +631,7 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state) if (_new_current_item && !_new_current_item->ignore_events()) { enter_event.detail = enter_detail; DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("ENTER %1/%2\n", _new_current_item->whatami(), _new_current_item->name)); + start_tooltip_timeout (_new_current_item); _new_current_item->Event ((GdkEvent*)&enter_event); } @@ -640,6 +717,11 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) _focused_item = 0; } + if (current_tooltip_item) { + current_tooltip_item = 0; + stop_tooltip_timeout (); + } + ScrollGroup* sg = dynamic_cast(item); if (sg) { scrollers.remove (sg); @@ -654,6 +736,18 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) } +void +GtkCanvas::on_size_allocate (Gtk::Allocation& a) +{ + EventBox::on_size_allocate (a); +#ifdef USE_CAIRO_IMAGE_SURFACE + /* allocate an image surface as large as the canvas itself */ + + canvas_image.clear (); + canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, a.get_width(), a.get_height()); +#endif +} + /** Handler for GDK expose events. * @param ev Event. * @return true if the event was handled. @@ -661,21 +755,86 @@ GtkCanvas::item_going_away (Item* item, boost::optional bounding_box) bool GtkCanvas::on_expose_event (GdkEventExpose* ev) { - Cairo::RefPtr cairo_context = get_window()->create_cairo_context (); - render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), cairo_context); +#ifdef USE_CAIRO_IMAGE_SURFACE + if (!canvas_image) { + canvas_image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, get_width(), get_height()); + } + Cairo::RefPtr draw_context = Cairo::Context::create (canvas_image); + Cairo::RefPtr window_context = get_window()->create_cairo_context (); +#else + Cairo::RefPtr draw_context = get_window()->create_cairo_context (); +#endif + + /* draw background color */ + + draw_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height); + draw_context->clip_preserve (); + set_source_rgba (draw_context, _bg_color); + draw_context->fill (); + + /* render canvas */ + + render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), draw_context); + +#ifdef USE_CAIRO_IMAGE_SURFACE + /* now blit our private surface back to the GDK one */ + + window_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height); + window_context->clip (); + window_context->set_source (canvas_image, 0, 0); + window_context->set_operator (Cairo::OPERATOR_SOURCE); + window_context->paint (); +#endif + return true; } -/** @return Our Cairo context, or 0 if we don't have one */ -Cairo::RefPtr -GtkCanvas::context () +/** Handler for GDK scroll events. + * @param ev Event. + * @return true if the event was handled. + */ +bool +GtkCanvas::on_scroll_event (GdkEventScroll* ev) { - Glib::RefPtr w = get_window (); - if (!w) { - return Cairo::RefPtr (); - } + /* translate event coordinates from window to canvas */ + + GdkEvent copy = *((GdkEvent*)ev); + Duple winpos = Duple (ev->x, ev->y); + Duple where = window_to_canvas (winpos); + + pick_current_item (winpos, ev->state); + + copy.button.x = where.x; + copy.button.y = where.y; + + /* Coordinates in the event will be canvas coordinates, correctly adjusted + for scroll if this GtkCanvas is in a GtkCanvasViewport. + */ + + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas scroll @ %1, %2 => %3\n", ev->x, ev->y, where)); + return deliver_event (reinterpret_cast(©)); +} + +/** Handler for GDK key press events. + * @param ev Event. + * @return true if the event was handled. + */ +bool +GtkCanvas::on_key_press_event (GdkEventKey* ev) +{ + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, "canvas key press\n"); + return deliver_event (reinterpret_cast(ev)); +} - return w->create_cairo_context (); +/** Handler for GDK key release events. + * @param ev Event. + * @return true if the event was handled. + */ +bool +GtkCanvas::on_key_release_event (GdkEventKey* ev) +{ + DEBUG_TRACE (PBD::DEBUG::CanvasEvents, "canvas key release\n"); + return deliver_event (reinterpret_cast(ev)); } /** Handler for GDK button press events. @@ -730,6 +889,28 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev) return deliver_event (reinterpret_cast(©)); } +bool +GtkCanvas::get_mouse_position (Duple& winpos) const +{ + int x; + int y; + Gdk::ModifierType mask; + Glib::RefPtr self = Glib::RefPtr::cast_const (get_window ()); + + if (!self) { + std::cerr << " no self window\n"; + winpos = Duple (0, 0); + return false; + } + + Glib::RefPtr win = self->get_pointer (x, y, mask); + + winpos.x = x; + winpos.y = y; + + return true; +} + /** Handler for GDK motion events. * @param ev Event. * @return true if the event was handled. @@ -737,6 +918,8 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev) bool GtkCanvas::on_motion_notify_event (GdkEventMotion* ev) { + hide_tooltip (); + /* translate event coordinates from window to canvas */ GdkEvent copy = *((GdkEvent*)ev); @@ -751,6 +934,8 @@ GtkCanvas::on_motion_notify_event (GdkEventMotion* ev) DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2 canvas @ %3, %4\n", ev->x, ev->y, copy.motion.x, copy.motion.y)); + MouseMotion (point); /* EMIT SIGNAL */ + pick_current_item (point, ev->state); /* Now deliver the motion event. It may seem a little inefficient @@ -772,6 +957,22 @@ GtkCanvas::on_enter_notify_event (GdkEventCrossing* ev) bool GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev) { + switch (ev->detail) { + case GDK_NOTIFY_ANCESTOR: + case GDK_NOTIFY_UNKNOWN: + case GDK_NOTIFY_VIRTUAL: + case GDK_NOTIFY_NONLINEAR: + case GDK_NOTIFY_NONLINEAR_VIRTUAL: + /* leaving window, cancel any tooltips */ + stop_tooltip_timeout (); + hide_tooltip (); + break; + default: + /* we don't care about any other kind + of leave event (notably GDK_NOTIFY_INFERIOR) + */ + break; + } _new_current_item = 0; deliver_enter_leave (Duple (ev->x, ev->y), ev->state); return true; @@ -875,6 +1076,117 @@ GtkCanvas::height() const return get_allocation().get_height(); } +void +GtkCanvas::start_tooltip_timeout (Item* item) +{ + stop_tooltip_timeout (); + + if (item) { + current_tooltip_item = item; + + /* wait for the first idle that happens after this is + called. this means that we've stopped processing events, which + in turn implies that the user has stopped doing stuff for a + little while. + */ + + Glib::signal_idle().connect (sigc::mem_fun (*this, &GtkCanvas::really_start_tooltip_timeout)); + } +} + +bool +GtkCanvas::really_start_tooltip_timeout () +{ + /* an idle has occured since we entered a tooltip-bearing widget. Now + * wait 1 second and if the timeout isn't cancelled, show the tooltip. + */ + + if (current_tooltip_item) { + tooltip_timeout_connection = Glib::signal_timeout().connect (sigc::mem_fun (*this, &GtkCanvas::show_tooltip), tooltip_timeout_msecs); + } + + return false; /* this is called from an idle callback, don't call it again */ +} + +void +GtkCanvas::stop_tooltip_timeout () +{ + current_tooltip_item = 0; + tooltip_timeout_connection.disconnect (); +} + +bool +GtkCanvas::show_tooltip () +{ + Rect tooltip_item_bbox; + + if (!current_tooltip_item || current_tooltip_item->tooltip().empty() || !current_tooltip_item->bounding_box()) { + return false; + } + + if (!tooltip_window) { + tooltip_window = new Gtk::Window (Gtk::WINDOW_POPUP); + tooltip_label = manage (new Gtk::Label); + tooltip_label->show (); + tooltip_window->add (*tooltip_label); + tooltip_window->set_border_width (6); + tooltip_window->set_name ("tooltip"); + } + + tooltip_label->set_text (current_tooltip_item->tooltip()); + + /* figure out where to position the tooltip */ + + Gtk::Widget* toplevel = get_toplevel(); + assert (toplevel); + int pointer_x, pointer_y; + Gdk::ModifierType mask; + + (void) toplevel->get_window()->get_pointer (pointer_x, pointer_y, mask); + + Duple tooltip_window_origin (pointer_x, pointer_y); + + /* convert to root window coordinates */ + + int win_x, win_y; + dynamic_cast(toplevel)->get_position (win_x, win_y); + + tooltip_window_origin = tooltip_window_origin.translate (Duple (win_x, win_y)); + + /* we don't want the pointer to be inside the window when it is + * displayed, because then we generate a leave/enter event pair when + * the window is displayed then hidden - the enter event will + * trigger a new tooltip timeout. + * + * So move the window right of the pointer position by just a enough + * to get it away from the pointer. + */ + + tooltip_window_origin.x += 20; + + /* move the tooltip window into position */ + + tooltip_window->move (tooltip_window_origin.x, tooltip_window_origin.y); + + /* ready to show */ + + tooltip_window->present (); + + /* called from a timeout handler, don't call it again */ + + return false; +} + +void +GtkCanvas::hide_tooltip () +{ + /* hide it if its there */ + + if (tooltip_window) { + tooltip_window->hide (); + } +} + /** Create a GtkCanvaSViewport. * @param hadj Adjustment to use for horizontal scrolling. * @param vadj Adjustment to use for vertica scrolling.