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 * #GtkLinkButton::activate-link signal and returning %TRUE from the
50 #include "gtklinkbutton.h"
54 #include "gtkclipboard.h"
56 #include "gtkimagemenuitem.h"
58 #include "gtkmainprivate.h"
59 #include "gtkmarshalers.h"
61 #include "gtkmenuitem.h"
62 #include "gtksizerequest.h"
65 #include "gtktooltip.h"
70 struct _GtkLinkButtonPrivate
76 GtkWidget *popup_menu;
93 static void gtk_link_button_finalize (GObject *object);
94 static void gtk_link_button_get_property (GObject *object,
98 static void gtk_link_button_set_property (GObject *object,
102 static void gtk_link_button_add (GtkContainer *container,
104 static gboolean gtk_link_button_button_press (GtkWidget *widget,
105 GdkEventButton *event);
106 static void gtk_link_button_clicked (GtkButton *button);
107 static gboolean gtk_link_button_popup_menu (GtkWidget *widget);
108 static void gtk_link_button_style_updated (GtkWidget *widget);
109 static gboolean gtk_link_button_enter_cb (GtkWidget *widget,
110 GdkEventCrossing *event,
112 static gboolean gtk_link_button_leave_cb (GtkWidget *widget,
113 GdkEventCrossing *event,
115 static void gtk_link_button_drag_data_get_cb (GtkWidget *widget,
116 GdkDragContext *context,
117 GtkSelectionData *selection,
121 static gboolean gtk_link_button_query_tooltip_cb (GtkWidget *widget,
124 gboolean keyboard_tip,
127 static gboolean gtk_link_button_activate_link (GtkLinkButton *link_button);
129 static const GtkTargetEntry link_drop_types[] = {
130 { "text/uri-list", 0, 0 },
131 { "_NETSCAPE_URL", 0, 0 }
134 static const GdkColor default_link_color = { 0, 0, 0, 0xeeee };
135 static const GdkColor default_visited_link_color = { 0, 0x5555, 0x1a1a, 0x8b8b };
137 static guint link_signals[LAST_SIGNAL] = { 0, };
139 G_DEFINE_TYPE (GtkLinkButton, gtk_link_button, GTK_TYPE_BUTTON)
142 gtk_link_button_class_init (GtkLinkButtonClass *klass)
144 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
145 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
146 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
147 GtkButtonClass *button_class = GTK_BUTTON_CLASS (klass);
149 gobject_class->set_property = gtk_link_button_set_property;
150 gobject_class->get_property = gtk_link_button_get_property;
151 gobject_class->finalize = gtk_link_button_finalize;
153 widget_class->button_press_event = gtk_link_button_button_press;
154 widget_class->popup_menu = gtk_link_button_popup_menu;
155 widget_class->style_updated = gtk_link_button_style_updated;
157 container_class->add = gtk_link_button_add;
159 button_class->clicked = gtk_link_button_clicked;
161 klass->activate_link = gtk_link_button_activate_link;
166 * The URI bound to this button.
170 g_object_class_install_property (gobject_class,
172 g_param_spec_string ("uri",
174 P_("The URI bound to this button"),
178 * GtkLinkButton:visited
180 * The 'visited' state of this button. A visited link is drawn in a
185 g_object_class_install_property (gobject_class,
187 g_param_spec_boolean ("visited",
189 P_("Whether this link has been visited."),
193 g_type_class_add_private (gobject_class, sizeof (GtkLinkButtonPrivate));
196 * GtkLinkButton::activate-link:
197 * @button: the #GtkLinkButton that emitted the signal
199 * The ::activate-link signal is emitted each time the #GtkLinkButton
202 * The default handler will call gtk_show_uri() with the URI stored inside
203 * the #GtkLinkButton:uri property.
205 * To override the default behavior, you can connect to the ::activate-link
206 * signal and stop the propagation of the signal by returning %TRUE from
209 link_signals[ACTIVATE_LINK] =
210 g_signal_new (I_("activate-link"),
211 G_TYPE_FROM_CLASS (klass),
213 G_STRUCT_OFFSET (GtkLinkButtonClass, activate_link),
214 _gtk_boolean_handled_accumulator, NULL,
215 _gtk_marshal_BOOLEAN__VOID,
220 gtk_link_button_init (GtkLinkButton *link_button)
222 link_button->priv = G_TYPE_INSTANCE_GET_PRIVATE (link_button,
223 GTK_TYPE_LINK_BUTTON,
224 GtkLinkButtonPrivate);
226 gtk_button_set_relief (GTK_BUTTON (link_button), GTK_RELIEF_NONE);
228 g_signal_connect (link_button, "enter-notify-event",
229 G_CALLBACK (gtk_link_button_enter_cb), NULL);
230 g_signal_connect (link_button, "leave-notify-event",
231 G_CALLBACK (gtk_link_button_leave_cb), NULL);
232 g_signal_connect (link_button, "drag-data-get",
233 G_CALLBACK (gtk_link_button_drag_data_get_cb), NULL);
235 g_object_set (link_button, "has-tooltip", TRUE, NULL);
236 g_signal_connect (link_button, "query-tooltip",
237 G_CALLBACK (gtk_link_button_query_tooltip_cb), NULL);
239 /* enable drag source */
240 gtk_drag_source_set (GTK_WIDGET (link_button),
242 link_drop_types, G_N_ELEMENTS (link_drop_types),
247 gtk_link_button_finalize (GObject *object)
249 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
251 g_free (link_button->priv->uri);
253 G_OBJECT_CLASS (gtk_link_button_parent_class)->finalize (object);
257 gtk_link_button_get_property (GObject *object,
262 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
267 g_value_set_string (value, link_button->priv->uri);
270 g_value_set_boolean (value, link_button->priv->visited);
273 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
279 gtk_link_button_set_property (GObject *object,
284 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
289 gtk_link_button_set_uri (link_button, g_value_get_string (value));
292 gtk_link_button_set_visited (link_button, g_value_get_boolean (value));
295 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
301 set_link_color (GtkLinkButton *link_button)
303 GdkColor *link_color = NULL;
306 label = gtk_bin_get_child (GTK_BIN (link_button));
307 if (!GTK_IS_LABEL (label))
310 if (link_button->priv->visited)
312 gtk_widget_style_get (GTK_WIDGET (link_button),
313 "visited-link-color", &link_color, NULL);
315 link_color = (GdkColor *) &default_visited_link_color;
319 gtk_widget_style_get (GTK_WIDGET (link_button),
320 "link-color", &link_color, NULL);
322 link_color = (GdkColor *) &default_link_color;
325 gtk_widget_modify_fg (label, GTK_STATE_NORMAL, link_color);
326 gtk_widget_modify_fg (label, GTK_STATE_ACTIVE, link_color);
327 gtk_widget_modify_fg (label, GTK_STATE_PRELIGHT, link_color);
328 gtk_widget_modify_fg (label, GTK_STATE_SELECTED, link_color);
330 if (link_color != &default_link_color &&
331 link_color != &default_visited_link_color)
332 gdk_color_free (link_color);
336 set_link_underline (GtkLinkButton *link_button)
340 label = gtk_bin_get_child (GTK_BIN (link_button));
341 if (GTK_IS_LABEL (label))
343 PangoAttrList *attributes;
344 PangoAttribute *uline;
346 uline = pango_attr_underline_new (PANGO_UNDERLINE_SINGLE);
347 uline->start_index = 0;
348 uline->end_index = G_MAXUINT;
349 attributes = pango_attr_list_new ();
350 pango_attr_list_insert (attributes, uline);
351 gtk_label_set_attributes (GTK_LABEL (label), attributes);
352 pango_attr_list_unref (attributes);
357 gtk_link_button_add (GtkContainer *container,
360 GTK_CONTAINER_CLASS (gtk_link_button_parent_class)->add (container, widget);
362 set_link_color (GTK_LINK_BUTTON (container));
363 set_link_underline (GTK_LINK_BUTTON (container));
367 gtk_link_button_style_updated (GtkWidget *widget)
369 GTK_WIDGET_CLASS (gtk_link_button_parent_class)->style_updated (widget);
371 set_link_color (GTK_LINK_BUTTON (widget));
375 set_hand_cursor (GtkWidget *widget,
381 display = gtk_widget_get_display (widget);
385 cursor = gdk_cursor_new_for_display (display, GDK_HAND2);
387 gdk_window_set_cursor (gtk_widget_get_window (widget), cursor);
388 gdk_display_flush (display);
391 g_object_unref (cursor);
395 popup_menu_detach (GtkWidget *attach_widget,
398 GtkLinkButton *link_button = GTK_LINK_BUTTON (attach_widget);
400 link_button->priv->popup_menu = NULL;
404 popup_position_func (GtkMenu *menu,
410 GtkLinkButton *link_button = GTK_LINK_BUTTON (user_data);
411 GtkLinkButtonPrivate *priv = link_button->priv;
412 GtkAllocation allocation;
413 GtkWidget *widget = GTK_WIDGET (link_button);
414 GdkScreen *screen = gtk_widget_get_screen (widget);
417 GdkRectangle monitor;
419 g_return_if_fail (gtk_widget_get_realized (widget));
421 gdk_window_get_origin (gtk_widget_get_window (widget), x, y);
423 gtk_widget_get_preferred_size (priv->popup_menu, &req, NULL);
425 gtk_widget_get_allocation (widget, &allocation);
426 *x += allocation.width / 2;
427 *y += allocation.height;
429 monitor_num = gdk_screen_get_monitor_at_point (screen, *x, *y);
430 gtk_menu_set_monitor (menu, monitor_num);
431 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
433 *x = CLAMP (*x, monitor.x, monitor.x + MAX (0, monitor.width - req.width));
434 *y = CLAMP (*y, monitor.y, monitor.y + MAX (0, monitor.height - req.height));
440 copy_activate_cb (GtkWidget *widget,
441 GtkLinkButton *link_button)
443 GtkLinkButtonPrivate *priv = link_button->priv;
445 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (link_button),
446 GDK_SELECTION_CLIPBOARD),
451 gtk_link_button_do_popup (GtkLinkButton *link_button,
452 GdkEventButton *event)
454 GtkLinkButtonPrivate *priv = link_button->priv;
460 button = event->button;
466 time = gtk_get_current_event_time ();
469 if (gtk_widget_get_realized (GTK_WIDGET (link_button)))
471 GtkWidget *menu_item;
473 if (priv->popup_menu)
474 gtk_widget_destroy (priv->popup_menu);
476 priv->popup_menu = gtk_menu_new ();
478 gtk_menu_attach_to_widget (GTK_MENU (priv->popup_menu),
479 GTK_WIDGET (link_button),
482 menu_item = gtk_image_menu_item_new_with_mnemonic (_("Copy URL"));
483 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item),
484 gtk_image_new_from_stock (GTK_STOCK_COPY,
485 GTK_ICON_SIZE_MENU));
486 g_signal_connect (menu_item, "activate",
487 G_CALLBACK (copy_activate_cb), link_button);
488 gtk_widget_show (menu_item);
489 gtk_menu_shell_append (GTK_MENU_SHELL (priv->popup_menu), menu_item);
492 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
497 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
498 popup_position_func, link_button,
500 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup_menu), FALSE);
506 gtk_link_button_button_press (GtkWidget *widget,
507 GdkEventButton *event)
509 if (!gtk_widget_has_focus (widget))
510 gtk_widget_grab_focus (widget);
512 if ((event->button == 3) && (event->type == GDK_BUTTON_PRESS))
514 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), event);
519 if (GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event)
520 return GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event (widget, event);
526 gtk_link_button_activate_link (GtkLinkButton *link_button)
531 if (gtk_widget_has_screen (GTK_WIDGET (link_button)))
532 screen = gtk_widget_get_screen (GTK_WIDGET (link_button));
537 gtk_show_uri (screen, link_button->priv->uri, GDK_CURRENT_TIME, &error);
540 g_warning ("Unable to show '%s': %s",
541 link_button->priv->uri,
543 g_error_free (error);
548 gtk_link_button_set_visited (link_button, TRUE);
554 gtk_link_button_clicked (GtkButton *button)
556 gboolean retval = FALSE;
558 g_signal_emit (button, link_signals[ACTIVATE_LINK], 0, &retval);
562 gtk_link_button_popup_menu (GtkWidget *widget)
564 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), NULL);
570 gtk_link_button_enter_cb (GtkWidget *widget,
571 GdkEventCrossing *crossing,
574 set_hand_cursor (widget, TRUE);
580 gtk_link_button_leave_cb (GtkWidget *widget,
581 GdkEventCrossing *crossing,
584 set_hand_cursor (widget, FALSE);
590 gtk_link_button_drag_data_get_cb (GtkWidget *widget,
591 GdkDragContext *context,
592 GtkSelectionData *selection,
597 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
600 uri = g_strdup_printf ("%s\r\n", link_button->priv->uri);
601 gtk_selection_data_set (selection,
602 gtk_selection_data_get_target (selection),
611 * gtk_link_button_new:
614 * Creates a new #GtkLinkButton with the URI as its text.
616 * Return value: a new link button widget.
621 gtk_link_button_new (const gchar *uri)
623 gchar *utf8_uri = NULL;
626 g_return_val_if_fail (uri != NULL, NULL);
628 if (g_utf8_validate (uri, -1, NULL))
630 utf8_uri = g_strdup (uri);
634 GError *conv_err = NULL;
636 utf8_uri = g_locale_to_utf8 (uri, -1, NULL, NULL, &conv_err);
639 g_warning ("Attempting to convert URI `%s' to UTF-8, but failed "
643 g_error_free (conv_err);
645 utf8_uri = g_strdup (_("Invalid URI"));
649 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
660 * gtk_link_button_new_with_label:
662 * @label: (allow-none): the text of the button
664 * Creates a new #GtkLinkButton containing a label.
666 * Return value: (transfer none): a new link button widget.
671 gtk_link_button_new_with_label (const gchar *uri,
676 g_return_val_if_fail (uri != NULL, NULL);
679 return gtk_link_button_new (uri);
681 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
690 gtk_link_button_query_tooltip_cb (GtkWidget *widget,
693 gboolean keyboard_tip,
697 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
698 const gchar *label, *uri;
700 label = gtk_button_get_label (GTK_BUTTON (link_button));
701 uri = link_button->priv->uri;
703 if (!gtk_widget_get_tooltip_text (widget)
704 && !gtk_widget_get_tooltip_markup (widget)
705 && label && *label != '\0' && uri && strcmp (label, uri) != 0)
707 gtk_tooltip_set_text (tooltip, uri);
716 * gtk_link_button_set_uri:
717 * @link_button: a #GtkLinkButton
720 * Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
721 * this unsets the 'visited' state of the button.
726 gtk_link_button_set_uri (GtkLinkButton *link_button,
729 GtkLinkButtonPrivate *priv;
731 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
732 g_return_if_fail (uri != NULL);
734 priv = link_button->priv;
737 priv->uri = g_strdup (uri);
739 g_object_notify (G_OBJECT (link_button), "uri");
741 gtk_link_button_set_visited (link_button, FALSE);
745 * gtk_link_button_get_uri:
746 * @link_button: a #GtkLinkButton
748 * Retrieves the URI set using gtk_link_button_set_uri().
750 * Return value: a valid URI. The returned string is owned by the link button
751 * and should not be modified or freed.
755 G_CONST_RETURN gchar *
756 gtk_link_button_get_uri (GtkLinkButton *link_button)
758 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), NULL);
760 return link_button->priv->uri;
764 * gtk_link_button_set_visited:
765 * @link_button: a #GtkLinkButton
766 * @visited: the new 'visited' state
768 * Sets the 'visited' state of the URI where the #GtkLinkButton
769 * points. See gtk_link_button_get_visited() for more details.
774 gtk_link_button_set_visited (GtkLinkButton *link_button,
777 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
779 visited = visited != FALSE;
781 if (link_button->priv->visited != visited)
783 link_button->priv->visited = visited;
785 set_link_color (link_button);
787 g_object_notify (G_OBJECT (link_button), "visited");
792 * gtk_link_button_get_visited:
793 * @link_button: a #GtkLinkButton
795 * Retrieves the 'visited' state of the URI where the #GtkLinkButton
796 * points. The button becomes visited when it is clicked. If the URI
797 * is changed on the button, the 'visited' state is unset again.
799 * The state may also be changed using gtk_link_button_set_visited().
801 * Return value: %TRUE if the link has been visited, %FALSE otherwise
806 gtk_link_button_get_visited (GtkLinkButton *link_button)
808 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), FALSE);
810 return link_button->priv->visited;