1 /* GTK - The GIMP Toolkit
2 * gtklinkbutton.c - an hyperlink-enabled button
4 * Copyright (C) 2006 Emmanuele Bassi <ebassi@gmail.com>
7 * Based on gnome-href code by:
8 * James Henstridge <james@daa.com.au>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Cambridge, MA 02139, USA.
27 #include "gtklinkbutton.h"
31 #include "gtkclipboard.h"
33 #include "gtkimagemenuitem.h"
37 #include "gtkmenuitem.h"
38 #include "gtksizerequest.h"
41 #include "gtktooltip.h"
46 struct _GtkLinkButtonPrivate
52 GtkWidget *popup_menu;
63 static void gtk_link_button_finalize (GObject *object);
64 static void gtk_link_button_get_property (GObject *object,
68 static void gtk_link_button_set_property (GObject *object,
72 static void gtk_link_button_add (GtkContainer *container,
74 static gboolean gtk_link_button_button_press (GtkWidget *widget,
75 GdkEventButton *event);
76 static void gtk_link_button_clicked (GtkButton *button);
77 static gboolean gtk_link_button_popup_menu (GtkWidget *widget);
78 static void gtk_link_button_style_set (GtkWidget *widget,
80 static gboolean gtk_link_button_enter_cb (GtkWidget *widget,
81 GdkEventCrossing *event,
83 static gboolean gtk_link_button_leave_cb (GtkWidget *widget,
84 GdkEventCrossing *event,
86 static void gtk_link_button_drag_data_get_cb (GtkWidget *widget,
87 GdkDragContext *context,
88 GtkSelectionData *selection,
92 static gboolean gtk_link_button_query_tooltip_cb (GtkWidget *widget,
95 gboolean keyboard_tip,
100 static const GtkTargetEntry link_drop_types[] = {
101 { "text/uri-list", 0, 0 },
102 { "_NETSCAPE_URL", 0, 0 }
105 static const GdkColor default_link_color = { 0, 0, 0, 0xeeee };
106 static const GdkColor default_visited_link_color = { 0, 0x5555, 0x1a1a, 0x8b8b };
108 static GtkLinkButtonUriFunc uri_func = NULL;
109 static gpointer uri_func_data = NULL;
110 static GDestroyNotify uri_func_destroy = NULL;
112 G_DEFINE_TYPE (GtkLinkButton, gtk_link_button, GTK_TYPE_BUTTON)
115 gtk_link_button_class_init (GtkLinkButtonClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
118 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
119 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
120 GtkButtonClass *button_class = GTK_BUTTON_CLASS (klass);
122 gobject_class->set_property = gtk_link_button_set_property;
123 gobject_class->get_property = gtk_link_button_get_property;
124 gobject_class->finalize = gtk_link_button_finalize;
126 widget_class->button_press_event = gtk_link_button_button_press;
127 widget_class->popup_menu = gtk_link_button_popup_menu;
128 widget_class->style_set = gtk_link_button_style_set;
130 container_class->add = gtk_link_button_add;
132 button_class->clicked = gtk_link_button_clicked;
137 * The URI bound to this button.
141 g_object_class_install_property (gobject_class,
143 g_param_spec_string ("uri",
145 P_("The URI bound to this button"),
149 * GtkLinkButton:visited
151 * The 'visited' state of this button. A visited link is drawn in a
156 g_object_class_install_property (gobject_class,
158 g_param_spec_boolean ("visited",
160 P_("Whether this link has been visited."),
164 g_type_class_add_private (gobject_class, sizeof (GtkLinkButtonPrivate));
168 gtk_link_button_init (GtkLinkButton *link_button)
170 link_button->priv = G_TYPE_INSTANCE_GET_PRIVATE (link_button,
171 GTK_TYPE_LINK_BUTTON,
172 GtkLinkButtonPrivate);
174 gtk_button_set_relief (GTK_BUTTON (link_button), GTK_RELIEF_NONE);
176 g_signal_connect (link_button, "enter-notify-event",
177 G_CALLBACK (gtk_link_button_enter_cb), NULL);
178 g_signal_connect (link_button, "leave-notify-event",
179 G_CALLBACK (gtk_link_button_leave_cb), NULL);
180 g_signal_connect (link_button, "drag-data-get",
181 G_CALLBACK (gtk_link_button_drag_data_get_cb), NULL);
183 g_object_set (link_button, "has-tooltip", TRUE, NULL);
184 g_signal_connect (link_button, "query-tooltip",
185 G_CALLBACK (gtk_link_button_query_tooltip_cb), NULL);
187 /* enable drag source */
188 gtk_drag_source_set (GTK_WIDGET (link_button),
190 link_drop_types, G_N_ELEMENTS (link_drop_types),
195 gtk_link_button_finalize (GObject *object)
197 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
199 g_free (link_button->priv->uri);
201 G_OBJECT_CLASS (gtk_link_button_parent_class)->finalize (object);
205 gtk_link_button_get_property (GObject *object,
210 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
215 g_value_set_string (value, link_button->priv->uri);
218 g_value_set_boolean (value, link_button->priv->visited);
221 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
227 gtk_link_button_set_property (GObject *object,
232 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
237 gtk_link_button_set_uri (link_button, g_value_get_string (value));
240 gtk_link_button_set_visited (link_button, g_value_get_boolean (value));
243 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
249 set_link_color (GtkLinkButton *link_button)
251 GdkColor *link_color = NULL;
254 label = gtk_bin_get_child (GTK_BIN (link_button));
255 if (!GTK_IS_LABEL (label))
258 if (link_button->priv->visited)
260 gtk_widget_style_get (GTK_WIDGET (link_button),
261 "visited-link-color", &link_color, NULL);
263 link_color = (GdkColor *) &default_visited_link_color;
267 gtk_widget_style_get (GTK_WIDGET (link_button),
268 "link-color", &link_color, NULL);
270 link_color = (GdkColor *) &default_link_color;
273 gtk_widget_modify_fg (label, GTK_STATE_NORMAL, link_color);
274 gtk_widget_modify_fg (label, GTK_STATE_ACTIVE, link_color);
275 gtk_widget_modify_fg (label, GTK_STATE_PRELIGHT, link_color);
276 gtk_widget_modify_fg (label, GTK_STATE_SELECTED, link_color);
278 if (link_color != &default_link_color &&
279 link_color != &default_visited_link_color)
280 gdk_color_free (link_color);
284 set_link_underline (GtkLinkButton *link_button)
288 label = gtk_bin_get_child (GTK_BIN (link_button));
289 if (GTK_IS_LABEL (label))
291 PangoAttrList *attributes;
292 PangoAttribute *uline;
294 uline = pango_attr_underline_new (PANGO_UNDERLINE_SINGLE);
295 uline->start_index = 0;
296 uline->end_index = G_MAXUINT;
297 attributes = pango_attr_list_new ();
298 pango_attr_list_insert (attributes, uline);
299 gtk_label_set_attributes (GTK_LABEL (label), attributes);
300 pango_attr_list_unref (attributes);
305 gtk_link_button_add (GtkContainer *container,
308 GTK_CONTAINER_CLASS (gtk_link_button_parent_class)->add (container, widget);
310 set_link_color (GTK_LINK_BUTTON (container));
311 set_link_underline (GTK_LINK_BUTTON (container));
315 gtk_link_button_style_set (GtkWidget *widget,
318 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
320 set_link_color (link_button);
324 set_hand_cursor (GtkWidget *widget,
330 display = gtk_widget_get_display (widget);
334 cursor = gdk_cursor_new_for_display (display, GDK_HAND2);
336 gdk_window_set_cursor (gtk_widget_get_window (widget), cursor);
337 gdk_display_flush (display);
340 gdk_cursor_unref (cursor);
344 popup_menu_detach (GtkWidget *attach_widget,
347 GtkLinkButton *link_button = GTK_LINK_BUTTON (attach_widget);
349 link_button->priv->popup_menu = NULL;
353 popup_position_func (GtkMenu *menu,
359 GtkLinkButton *link_button = GTK_LINK_BUTTON (user_data);
360 GtkLinkButtonPrivate *priv = link_button->priv;
361 GtkAllocation allocation;
362 GtkWidget *widget = GTK_WIDGET (link_button);
363 GdkScreen *screen = gtk_widget_get_screen (widget);
366 GdkRectangle monitor;
368 g_return_if_fail (gtk_widget_get_realized (widget));
370 gdk_window_get_origin (gtk_widget_get_window (widget), x, y);
372 gtk_size_request_get_size (GTK_SIZE_REQUEST (priv->popup_menu),
375 gtk_widget_get_allocation (widget, &allocation);
376 *x += allocation.width / 2;
377 *y += allocation.height;
379 monitor_num = gdk_screen_get_monitor_at_point (screen, *x, *y);
380 gtk_menu_set_monitor (menu, monitor_num);
381 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
383 *x = CLAMP (*x, monitor.x, monitor.x + MAX (0, monitor.width - req.width));
384 *y = CLAMP (*y, monitor.y, monitor.y + MAX (0, monitor.height - req.height));
390 copy_activate_cb (GtkWidget *widget,
391 GtkLinkButton *link_button)
393 GtkLinkButtonPrivate *priv = link_button->priv;
395 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (link_button),
396 GDK_SELECTION_CLIPBOARD),
401 gtk_link_button_do_popup (GtkLinkButton *link_button,
402 GdkEventButton *event)
404 GtkLinkButtonPrivate *priv = link_button->priv;
410 button = event->button;
416 time = gtk_get_current_event_time ();
419 if (gtk_widget_get_realized (GTK_WIDGET (link_button)))
421 GtkWidget *menu_item;
423 if (priv->popup_menu)
424 gtk_widget_destroy (priv->popup_menu);
426 priv->popup_menu = gtk_menu_new ();
428 gtk_menu_attach_to_widget (GTK_MENU (priv->popup_menu),
429 GTK_WIDGET (link_button),
432 menu_item = gtk_image_menu_item_new_with_mnemonic (_("Copy URL"));
433 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item),
434 gtk_image_new_from_stock (GTK_STOCK_COPY,
435 GTK_ICON_SIZE_MENU));
436 g_signal_connect (menu_item, "activate",
437 G_CALLBACK (copy_activate_cb), link_button);
438 gtk_widget_show (menu_item);
439 gtk_menu_shell_append (GTK_MENU_SHELL (priv->popup_menu), menu_item);
442 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
447 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
448 popup_position_func, link_button,
450 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup_menu), FALSE);
456 gtk_link_button_button_press (GtkWidget *widget,
457 GdkEventButton *event)
459 if (!gtk_widget_has_focus (widget))
460 gtk_widget_grab_focus (widget);
462 if ((event->button == 3) && (event->type == GDK_BUTTON_PRESS))
464 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), event);
469 if (GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event)
470 return GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event (widget, event);
476 gtk_link_button_clicked (GtkButton *button)
478 GtkLinkButton *link_button = GTK_LINK_BUTTON (button);
481 (* uri_func) (link_button, link_button->priv->uri, uri_func_data);
487 if (gtk_widget_has_screen (GTK_WIDGET (button)))
488 screen = gtk_widget_get_screen (GTK_WIDGET (button));
493 gtk_show_uri (screen, link_button->priv->uri, GDK_CURRENT_TIME, &error);
496 g_warning ("Unable to show '%s': %s",
497 link_button->priv->uri,
499 g_error_free (error);
503 gtk_link_button_set_visited (link_button, TRUE);
507 gtk_link_button_popup_menu (GtkWidget *widget)
509 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), NULL);
515 gtk_link_button_enter_cb (GtkWidget *widget,
516 GdkEventCrossing *crossing,
519 set_hand_cursor (widget, TRUE);
525 gtk_link_button_leave_cb (GtkWidget *widget,
526 GdkEventCrossing *crossing,
529 set_hand_cursor (widget, FALSE);
535 gtk_link_button_drag_data_get_cb (GtkWidget *widget,
536 GdkDragContext *context,
537 GtkSelectionData *selection,
542 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
545 uri = g_strdup_printf ("%s\r\n", link_button->priv->uri);
546 gtk_selection_data_set (selection,
556 * gtk_link_button_new:
559 * Creates a new #GtkLinkButton with the URI as its text.
561 * Return value: a new link button widget.
566 gtk_link_button_new (const gchar *uri)
568 gchar *utf8_uri = NULL;
571 g_return_val_if_fail (uri != NULL, NULL);
573 if (g_utf8_validate (uri, -1, NULL))
575 utf8_uri = g_strdup (uri);
579 GError *conv_err = NULL;
581 utf8_uri = g_locale_to_utf8 (uri, -1, NULL, NULL, &conv_err);
584 g_warning ("Attempting to convert URI `%s' to UTF-8, but failed "
588 g_error_free (conv_err);
590 utf8_uri = g_strdup (_("Invalid URI"));
594 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
605 * gtk_link_button_new_with_label:
607 * @label: (allow-none): the text of the button
609 * Creates a new #GtkLinkButton containing a label.
611 * Return value: (transfer none): a new link button widget.
616 gtk_link_button_new_with_label (const gchar *uri,
621 g_return_val_if_fail (uri != NULL, NULL);
624 return gtk_link_button_new (uri);
626 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
635 gtk_link_button_query_tooltip_cb (GtkWidget *widget,
638 gboolean keyboard_tip,
642 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
643 const gchar *label, *uri;
645 label = gtk_button_get_label (GTK_BUTTON (link_button));
646 uri = link_button->priv->uri;
648 if (!gtk_widget_get_tooltip_text (widget)
649 && !gtk_widget_get_tooltip_markup (widget)
650 && label && *label != '\0' && uri && strcmp (label, uri) != 0)
652 gtk_tooltip_set_text (tooltip, uri);
661 * gtk_link_button_set_uri:
662 * @link_button: a #GtkLinkButton
665 * Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
666 * this unsets the 'visited' state of the button.
671 gtk_link_button_set_uri (GtkLinkButton *link_button,
674 GtkLinkButtonPrivate *priv;
676 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
677 g_return_if_fail (uri != NULL);
679 priv = link_button->priv;
682 priv->uri = g_strdup (uri);
684 g_object_notify (G_OBJECT (link_button), "uri");
686 gtk_link_button_set_visited (link_button, FALSE);
690 * gtk_link_button_get_uri:
691 * @link_button: a #GtkLinkButton
693 * Retrieves the URI set using gtk_link_button_set_uri().
695 * Return value: a valid URI. The returned string is owned by the link button
696 * and should not be modified or freed.
700 G_CONST_RETURN gchar *
701 gtk_link_button_get_uri (GtkLinkButton *link_button)
703 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), NULL);
705 return link_button->priv->uri;
709 * gtk_link_button_set_uri_hook:
710 * @func: (allow-none): a function called each time a #GtkLinkButton is clicked, or %NULL
711 * @data: (allow-none): user data to be passed to @func, or %NULL
712 * @destroy: (allow-none): a #GDestroyNotify that gets called when @data is no longer needed, or %NULL
714 * Sets @func as the function that should be invoked every time a user clicks
715 * a #GtkLinkButton. This function is called before every callback registered
716 * for the "clicked" signal.
718 * If no uri hook has been set, GTK+ defaults to calling gtk_show_uri().
720 * Return value: the previously set hook function.
725 gtk_link_button_set_uri_hook (GtkLinkButtonUriFunc func,
727 GDestroyNotify destroy)
729 GtkLinkButtonUriFunc old_uri_func;
731 if (uri_func_destroy)
732 (* uri_func_destroy) (uri_func_data);
734 old_uri_func = uri_func;
737 uri_func_data = data;
738 uri_func_destroy = destroy;
744 * gtk_link_button_set_visited:
745 * @link_button: a #GtkLinkButton
746 * @visited: the new 'visited' state
748 * Sets the 'visited' state of the URI where the #GtkLinkButton
749 * points. See gtk_link_button_get_visited() for more details.
754 gtk_link_button_set_visited (GtkLinkButton *link_button,
757 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
759 visited = visited != FALSE;
761 if (link_button->priv->visited != visited)
763 link_button->priv->visited = visited;
765 set_link_color (link_button);
767 g_object_notify (G_OBJECT (link_button), "visited");
772 * gtk_link_button_get_visited:
773 * @link_button: a #GtkLinkButton
775 * Retrieves the 'visited' state of the URI where the #GtkLinkButton
776 * points. The button becomes visited when it is clicked. If the URI
777 * is changed on the button, the 'visited' state is unset again.
779 * The state may also be changed using gtk_link_button_set_visited().
781 * Return value: %TRUE if the link has been visited, %FALSE otherwise
786 gtk_link_button_get_visited (GtkLinkButton *link_button)
788 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), FALSE);
790 return link_button->priv->visited;