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.
26 * SECTION:gtklinkbutton
27 * @Title: GtkLinkButton
28 * @Short_description: Create buttons bound to a URL
29 * @See_also: #GtkButton
31 * A GtkLinkButton is a #GtkButton with a hyperlink, similar to the one
32 * used by web browsers, which triggers an action when clicked. It is useful
33 * to show quick links to resources.
35 * A link button is created by calling either gtk_link_button_new() or
36 * gtk_link_button_new_with_label(). If using the former, the URI you pass
37 * to the constructor is used as a label for the widget.
39 * The URI bound to a GtkLinkButton can be set specifically using
40 * gtk_link_button_set_uri(), and retrieved using gtk_link_button_get_uri().
42 * By default, GtkLinkButton calls gtk_show_uri() when the button is
43 * clicked. This behaviour can be overridden by connecting to the
44 * #GtkButton::clicked signal.
49 #include "gtklinkbutton.h"
53 #include "gtkclipboard.h"
55 #include "gtkimagemenuitem.h"
59 #include "gtkmenuitem.h"
60 #include "gtksizerequest.h"
63 #include "gtktooltip.h"
68 struct _GtkLinkButtonPrivate
74 GtkWidget *popup_menu;
85 static void gtk_link_button_finalize (GObject *object);
86 static void gtk_link_button_get_property (GObject *object,
90 static void gtk_link_button_set_property (GObject *object,
94 static void gtk_link_button_add (GtkContainer *container,
96 static gboolean gtk_link_button_button_press (GtkWidget *widget,
97 GdkEventButton *event);
98 static void gtk_link_button_clicked (GtkButton *button);
99 static gboolean gtk_link_button_popup_menu (GtkWidget *widget);
100 static void gtk_link_button_style_set (GtkWidget *widget,
101 GtkStyle *old_style);
102 static gboolean gtk_link_button_enter_cb (GtkWidget *widget,
103 GdkEventCrossing *event,
105 static gboolean gtk_link_button_leave_cb (GtkWidget *widget,
106 GdkEventCrossing *event,
108 static void gtk_link_button_drag_data_get_cb (GtkWidget *widget,
109 GdkDragContext *context,
110 GtkSelectionData *selection,
114 static gboolean gtk_link_button_query_tooltip_cb (GtkWidget *widget,
117 gboolean keyboard_tip,
122 static const GtkTargetEntry link_drop_types[] = {
123 { "text/uri-list", 0, 0 },
124 { "_NETSCAPE_URL", 0, 0 }
127 static const GdkColor default_link_color = { 0, 0, 0, 0xeeee };
128 static const GdkColor default_visited_link_color = { 0, 0x5555, 0x1a1a, 0x8b8b };
130 G_DEFINE_TYPE (GtkLinkButton, gtk_link_button, GTK_TYPE_BUTTON)
133 gtk_link_button_class_init (GtkLinkButtonClass *klass)
135 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
136 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
137 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
138 GtkButtonClass *button_class = GTK_BUTTON_CLASS (klass);
140 gobject_class->set_property = gtk_link_button_set_property;
141 gobject_class->get_property = gtk_link_button_get_property;
142 gobject_class->finalize = gtk_link_button_finalize;
144 widget_class->button_press_event = gtk_link_button_button_press;
145 widget_class->popup_menu = gtk_link_button_popup_menu;
146 widget_class->style_set = gtk_link_button_style_set;
148 container_class->add = gtk_link_button_add;
150 button_class->clicked = gtk_link_button_clicked;
155 * The URI bound to this button.
159 g_object_class_install_property (gobject_class,
161 g_param_spec_string ("uri",
163 P_("The URI bound to this button"),
167 * GtkLinkButton:visited
169 * The 'visited' state of this button. A visited link is drawn in a
174 g_object_class_install_property (gobject_class,
176 g_param_spec_boolean ("visited",
178 P_("Whether this link has been visited."),
182 g_type_class_add_private (gobject_class, sizeof (GtkLinkButtonPrivate));
186 gtk_link_button_init (GtkLinkButton *link_button)
188 link_button->priv = G_TYPE_INSTANCE_GET_PRIVATE (link_button,
189 GTK_TYPE_LINK_BUTTON,
190 GtkLinkButtonPrivate);
192 gtk_button_set_relief (GTK_BUTTON (link_button), GTK_RELIEF_NONE);
194 g_signal_connect (link_button, "enter-notify-event",
195 G_CALLBACK (gtk_link_button_enter_cb), NULL);
196 g_signal_connect (link_button, "leave-notify-event",
197 G_CALLBACK (gtk_link_button_leave_cb), NULL);
198 g_signal_connect (link_button, "drag-data-get",
199 G_CALLBACK (gtk_link_button_drag_data_get_cb), NULL);
201 g_object_set (link_button, "has-tooltip", TRUE, NULL);
202 g_signal_connect (link_button, "query-tooltip",
203 G_CALLBACK (gtk_link_button_query_tooltip_cb), NULL);
205 /* enable drag source */
206 gtk_drag_source_set (GTK_WIDGET (link_button),
208 link_drop_types, G_N_ELEMENTS (link_drop_types),
213 gtk_link_button_finalize (GObject *object)
215 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
217 g_free (link_button->priv->uri);
219 G_OBJECT_CLASS (gtk_link_button_parent_class)->finalize (object);
223 gtk_link_button_get_property (GObject *object,
228 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
233 g_value_set_string (value, link_button->priv->uri);
236 g_value_set_boolean (value, link_button->priv->visited);
239 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
245 gtk_link_button_set_property (GObject *object,
250 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
255 gtk_link_button_set_uri (link_button, g_value_get_string (value));
258 gtk_link_button_set_visited (link_button, g_value_get_boolean (value));
261 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
267 set_link_color (GtkLinkButton *link_button)
269 GdkColor *link_color = NULL;
272 label = gtk_bin_get_child (GTK_BIN (link_button));
273 if (!GTK_IS_LABEL (label))
276 if (link_button->priv->visited)
278 gtk_widget_style_get (GTK_WIDGET (link_button),
279 "visited-link-color", &link_color, NULL);
281 link_color = (GdkColor *) &default_visited_link_color;
285 gtk_widget_style_get (GTK_WIDGET (link_button),
286 "link-color", &link_color, NULL);
288 link_color = (GdkColor *) &default_link_color;
291 gtk_widget_modify_fg (label, GTK_STATE_NORMAL, link_color);
292 gtk_widget_modify_fg (label, GTK_STATE_ACTIVE, link_color);
293 gtk_widget_modify_fg (label, GTK_STATE_PRELIGHT, link_color);
294 gtk_widget_modify_fg (label, GTK_STATE_SELECTED, link_color);
296 if (link_color != &default_link_color &&
297 link_color != &default_visited_link_color)
298 gdk_color_free (link_color);
302 set_link_underline (GtkLinkButton *link_button)
306 label = gtk_bin_get_child (GTK_BIN (link_button));
307 if (GTK_IS_LABEL (label))
309 PangoAttrList *attributes;
310 PangoAttribute *uline;
312 uline = pango_attr_underline_new (PANGO_UNDERLINE_SINGLE);
313 uline->start_index = 0;
314 uline->end_index = G_MAXUINT;
315 attributes = pango_attr_list_new ();
316 pango_attr_list_insert (attributes, uline);
317 gtk_label_set_attributes (GTK_LABEL (label), attributes);
318 pango_attr_list_unref (attributes);
323 gtk_link_button_add (GtkContainer *container,
326 GTK_CONTAINER_CLASS (gtk_link_button_parent_class)->add (container, widget);
328 set_link_color (GTK_LINK_BUTTON (container));
329 set_link_underline (GTK_LINK_BUTTON (container));
333 gtk_link_button_style_set (GtkWidget *widget,
336 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
338 set_link_color (link_button);
342 set_hand_cursor (GtkWidget *widget,
348 display = gtk_widget_get_display (widget);
352 cursor = gdk_cursor_new_for_display (display, GDK_HAND2);
354 gdk_window_set_cursor (gtk_widget_get_window (widget), cursor);
355 gdk_display_flush (display);
358 gdk_cursor_unref (cursor);
362 popup_menu_detach (GtkWidget *attach_widget,
365 GtkLinkButton *link_button = GTK_LINK_BUTTON (attach_widget);
367 link_button->priv->popup_menu = NULL;
371 popup_position_func (GtkMenu *menu,
377 GtkLinkButton *link_button = GTK_LINK_BUTTON (user_data);
378 GtkLinkButtonPrivate *priv = link_button->priv;
379 GtkAllocation allocation;
380 GtkWidget *widget = GTK_WIDGET (link_button);
381 GdkScreen *screen = gtk_widget_get_screen (widget);
384 GdkRectangle monitor;
386 g_return_if_fail (gtk_widget_get_realized (widget));
388 gdk_window_get_origin (gtk_widget_get_window (widget), x, y);
390 gtk_size_request_get_size (GTK_SIZE_REQUEST (priv->popup_menu),
393 gtk_widget_get_allocation (widget, &allocation);
394 *x += allocation.width / 2;
395 *y += allocation.height;
397 monitor_num = gdk_screen_get_monitor_at_point (screen, *x, *y);
398 gtk_menu_set_monitor (menu, monitor_num);
399 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
401 *x = CLAMP (*x, monitor.x, monitor.x + MAX (0, monitor.width - req.width));
402 *y = CLAMP (*y, monitor.y, monitor.y + MAX (0, monitor.height - req.height));
408 copy_activate_cb (GtkWidget *widget,
409 GtkLinkButton *link_button)
411 GtkLinkButtonPrivate *priv = link_button->priv;
413 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (link_button),
414 GDK_SELECTION_CLIPBOARD),
419 gtk_link_button_do_popup (GtkLinkButton *link_button,
420 GdkEventButton *event)
422 GtkLinkButtonPrivate *priv = link_button->priv;
428 button = event->button;
434 time = gtk_get_current_event_time ();
437 if (gtk_widget_get_realized (GTK_WIDGET (link_button)))
439 GtkWidget *menu_item;
441 if (priv->popup_menu)
442 gtk_widget_destroy (priv->popup_menu);
444 priv->popup_menu = gtk_menu_new ();
446 gtk_menu_attach_to_widget (GTK_MENU (priv->popup_menu),
447 GTK_WIDGET (link_button),
450 menu_item = gtk_image_menu_item_new_with_mnemonic (_("Copy URL"));
451 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item),
452 gtk_image_new_from_stock (GTK_STOCK_COPY,
453 GTK_ICON_SIZE_MENU));
454 g_signal_connect (menu_item, "activate",
455 G_CALLBACK (copy_activate_cb), link_button);
456 gtk_widget_show (menu_item);
457 gtk_menu_shell_append (GTK_MENU_SHELL (priv->popup_menu), menu_item);
460 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
465 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
466 popup_position_func, link_button,
468 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup_menu), FALSE);
474 gtk_link_button_button_press (GtkWidget *widget,
475 GdkEventButton *event)
477 if (!gtk_widget_has_focus (widget))
478 gtk_widget_grab_focus (widget);
480 if ((event->button == 3) && (event->type == GDK_BUTTON_PRESS))
482 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), event);
487 if (GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event)
488 return GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event (widget, event);
494 gtk_link_button_clicked (GtkButton *button)
496 GtkLinkButton *link_button = GTK_LINK_BUTTON (button);
500 if (gtk_widget_has_screen (GTK_WIDGET (button)))
501 screen = gtk_widget_get_screen (GTK_WIDGET (button));
506 gtk_show_uri (screen, link_button->priv->uri, GDK_CURRENT_TIME, &error);
509 g_warning ("Unable to show '%s': %s",
510 link_button->priv->uri,
512 g_error_free (error);
515 gtk_link_button_set_visited (link_button, TRUE);
519 gtk_link_button_popup_menu (GtkWidget *widget)
521 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), NULL);
527 gtk_link_button_enter_cb (GtkWidget *widget,
528 GdkEventCrossing *crossing,
531 set_hand_cursor (widget, TRUE);
537 gtk_link_button_leave_cb (GtkWidget *widget,
538 GdkEventCrossing *crossing,
541 set_hand_cursor (widget, FALSE);
547 gtk_link_button_drag_data_get_cb (GtkWidget *widget,
548 GdkDragContext *context,
549 GtkSelectionData *selection,
554 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
557 uri = g_strdup_printf ("%s\r\n", link_button->priv->uri);
558 gtk_selection_data_set (selection,
568 * gtk_link_button_new:
571 * Creates a new #GtkLinkButton with the URI as its text.
573 * Return value: a new link button widget.
578 gtk_link_button_new (const gchar *uri)
580 gchar *utf8_uri = NULL;
583 g_return_val_if_fail (uri != NULL, NULL);
585 if (g_utf8_validate (uri, -1, NULL))
587 utf8_uri = g_strdup (uri);
591 GError *conv_err = NULL;
593 utf8_uri = g_locale_to_utf8 (uri, -1, NULL, NULL, &conv_err);
596 g_warning ("Attempting to convert URI `%s' to UTF-8, but failed "
600 g_error_free (conv_err);
602 utf8_uri = g_strdup (_("Invalid URI"));
606 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
617 * gtk_link_button_new_with_label:
619 * @label: (allow-none): the text of the button
621 * Creates a new #GtkLinkButton containing a label.
623 * Return value: (transfer none): a new link button widget.
628 gtk_link_button_new_with_label (const gchar *uri,
633 g_return_val_if_fail (uri != NULL, NULL);
636 return gtk_link_button_new (uri);
638 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
647 gtk_link_button_query_tooltip_cb (GtkWidget *widget,
650 gboolean keyboard_tip,
654 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
655 const gchar *label, *uri;
657 label = gtk_button_get_label (GTK_BUTTON (link_button));
658 uri = link_button->priv->uri;
660 if (!gtk_widget_get_tooltip_text (widget)
661 && !gtk_widget_get_tooltip_markup (widget)
662 && label && *label != '\0' && uri && strcmp (label, uri) != 0)
664 gtk_tooltip_set_text (tooltip, uri);
673 * gtk_link_button_set_uri:
674 * @link_button: a #GtkLinkButton
677 * Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
678 * this unsets the 'visited' state of the button.
683 gtk_link_button_set_uri (GtkLinkButton *link_button,
686 GtkLinkButtonPrivate *priv;
688 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
689 g_return_if_fail (uri != NULL);
691 priv = link_button->priv;
694 priv->uri = g_strdup (uri);
696 g_object_notify (G_OBJECT (link_button), "uri");
698 gtk_link_button_set_visited (link_button, FALSE);
702 * gtk_link_button_get_uri:
703 * @link_button: a #GtkLinkButton
705 * Retrieves the URI set using gtk_link_button_set_uri().
707 * Return value: a valid URI. The returned string is owned by the link button
708 * and should not be modified or freed.
712 G_CONST_RETURN gchar *
713 gtk_link_button_get_uri (GtkLinkButton *link_button)
715 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), NULL);
717 return link_button->priv->uri;
721 * gtk_link_button_set_visited:
722 * @link_button: a #GtkLinkButton
723 * @visited: the new 'visited' state
725 * Sets the 'visited' state of the URI where the #GtkLinkButton
726 * points. See gtk_link_button_get_visited() for more details.
731 gtk_link_button_set_visited (GtkLinkButton *link_button,
734 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
736 visited = visited != FALSE;
738 if (link_button->priv->visited != visited)
740 link_button->priv->visited = visited;
742 set_link_color (link_button);
744 g_object_notify (G_OBJECT (link_button), "visited");
749 * gtk_link_button_get_visited:
750 * @link_button: a #GtkLinkButton
752 * Retrieves the 'visited' state of the URI where the #GtkLinkButton
753 * points. The button becomes visited when it is clicked. If the URI
754 * is changed on the button, the 'visited' state is unset again.
756 * The state may also be changed using gtk_link_button_set_visited().
758 * Return value: %TRUE if the link has been visited, %FALSE otherwise
763 gtk_link_button_get_visited (GtkLinkButton *link_button)
765 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), FALSE);
767 return link_button->priv->visited;