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.
29 #include "gtkclipboard.h"
31 #include "gtkimagemenuitem.h"
35 #include "gtkmenuitem.h"
38 #include "gtktooltip.h"
40 #include "gtklinkbutton.h"
45 struct _GtkLinkButtonPrivate
51 GtkWidget *popup_menu;
61 #define GTK_LINK_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_LINK_BUTTON, GtkLinkButtonPrivate))
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 = GTK_LINK_BUTTON_GET_PRIVATE (link_button),
172 gtk_button_set_relief (GTK_BUTTON (link_button), GTK_RELIEF_NONE);
174 g_signal_connect (link_button, "enter-notify-event",
175 G_CALLBACK (gtk_link_button_enter_cb), NULL);
176 g_signal_connect (link_button, "leave-notify-event",
177 G_CALLBACK (gtk_link_button_leave_cb), NULL);
178 g_signal_connect (link_button, "drag-data-get",
179 G_CALLBACK (gtk_link_button_drag_data_get_cb), NULL);
181 g_object_set (link_button, "has-tooltip", TRUE, NULL);
182 g_signal_connect (link_button, "query-tooltip",
183 G_CALLBACK (gtk_link_button_query_tooltip_cb), NULL);
185 /* enable drag source */
186 gtk_drag_source_set (GTK_WIDGET (link_button),
188 link_drop_types, G_N_ELEMENTS (link_drop_types),
193 gtk_link_button_finalize (GObject *object)
195 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
197 g_free (link_button->priv->uri);
199 G_OBJECT_CLASS (gtk_link_button_parent_class)->finalize (object);
203 gtk_link_button_get_property (GObject *object,
208 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
213 g_value_set_string (value, link_button->priv->uri);
216 g_value_set_boolean (value, link_button->priv->visited);
219 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
225 gtk_link_button_set_property (GObject *object,
230 GtkLinkButton *link_button = GTK_LINK_BUTTON (object);
235 gtk_link_button_set_uri (link_button, g_value_get_string (value));
238 gtk_link_button_set_visited (link_button, g_value_get_boolean (value));
241 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
247 set_link_color (GtkLinkButton *link_button)
249 GdkColor *link_color = NULL;
252 label = gtk_bin_get_child (GTK_BIN (link_button));
253 if (!GTK_IS_LABEL (label))
256 if (link_button->priv->visited)
258 gtk_widget_style_get (GTK_WIDGET (link_button),
259 "visited-link-color", &link_color, NULL);
261 link_color = (GdkColor *) &default_visited_link_color;
265 gtk_widget_style_get (GTK_WIDGET (link_button),
266 "link-color", &link_color, NULL);
268 link_color = (GdkColor *) &default_link_color;
271 gtk_widget_modify_fg (label, GTK_STATE_NORMAL, link_color);
272 gtk_widget_modify_fg (label, GTK_STATE_ACTIVE, link_color);
273 gtk_widget_modify_fg (label, GTK_STATE_PRELIGHT, link_color);
274 gtk_widget_modify_fg (label, GTK_STATE_SELECTED, link_color);
276 if (link_color != &default_link_color &&
277 link_color != &default_visited_link_color)
278 gdk_color_free (link_color);
282 set_link_underline (GtkLinkButton *link_button)
286 label = gtk_bin_get_child (GTK_BIN (link_button));
287 if (GTK_IS_LABEL (label))
289 PangoAttrList *attributes;
290 PangoAttribute *uline;
292 uline = pango_attr_underline_new (PANGO_UNDERLINE_SINGLE);
293 uline->start_index = 0;
294 uline->end_index = G_MAXUINT;
295 attributes = pango_attr_list_new ();
296 pango_attr_list_insert (attributes, uline);
297 gtk_label_set_attributes (GTK_LABEL (label), attributes);
298 pango_attr_list_unref (attributes);
303 gtk_link_button_add (GtkContainer *container,
306 GTK_CONTAINER_CLASS (gtk_link_button_parent_class)->add (container, widget);
308 set_link_color (GTK_LINK_BUTTON (container));
309 set_link_underline (GTK_LINK_BUTTON (container));
313 gtk_link_button_style_set (GtkWidget *widget,
316 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
318 set_link_color (link_button);
322 set_hand_cursor (GtkWidget *widget,
328 display = gtk_widget_get_display (widget);
332 cursor = gdk_cursor_new_for_display (display, GDK_HAND2);
334 gdk_window_set_cursor (widget->window, cursor);
335 gdk_display_flush (display);
338 gdk_cursor_unref (cursor);
342 popup_menu_detach (GtkWidget *attach_widget,
345 GtkLinkButton *link_button = GTK_LINK_BUTTON (attach_widget);
347 link_button->priv->popup_menu = NULL;
351 popup_position_func (GtkMenu *menu,
357 GtkLinkButton *link_button = GTK_LINK_BUTTON (user_data);
358 GtkLinkButtonPrivate *priv = link_button->priv;
359 GtkWidget *widget = GTK_WIDGET (link_button);
360 GdkScreen *screen = gtk_widget_get_screen (widget);
363 GdkRectangle monitor;
365 g_return_if_fail (gtk_widget_get_realized (widget));
367 gdk_window_get_origin (widget->window, x, y);
369 gtk_widget_size_request (priv->popup_menu, &req);
371 *x += widget->allocation.width / 2;
372 *y += widget->allocation.height;
374 monitor_num = gdk_screen_get_monitor_at_point (screen, *x, *y);
375 gtk_menu_set_monitor (menu, monitor_num);
376 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
378 *x = CLAMP (*x, monitor.x, monitor.x + MAX (0, monitor.width - req.width));
379 *y = CLAMP (*y, monitor.y, monitor.y + MAX (0, monitor.height - req.height));
385 copy_activate_cb (GtkWidget *widget,
386 GtkLinkButton *link_button)
388 GtkLinkButtonPrivate *priv = link_button->priv;
390 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (link_button),
391 GDK_SELECTION_CLIPBOARD),
396 gtk_link_button_do_popup (GtkLinkButton *link_button,
397 GdkEventButton *event)
399 GtkLinkButtonPrivate *priv = link_button->priv;
405 button = event->button;
411 time = gtk_get_current_event_time ();
414 if (gtk_widget_get_realized (GTK_WIDGET (link_button)))
416 GtkWidget *menu_item;
418 if (priv->popup_menu)
419 gtk_widget_destroy (priv->popup_menu);
421 priv->popup_menu = gtk_menu_new ();
423 gtk_menu_attach_to_widget (GTK_MENU (priv->popup_menu),
424 GTK_WIDGET (link_button),
427 menu_item = gtk_image_menu_item_new_with_mnemonic (_("Copy URL"));
428 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item),
429 gtk_image_new_from_stock (GTK_STOCK_COPY,
430 GTK_ICON_SIZE_MENU));
431 g_signal_connect (menu_item, "activate",
432 G_CALLBACK (copy_activate_cb), link_button);
433 gtk_widget_show (menu_item);
434 gtk_menu_shell_append (GTK_MENU_SHELL (priv->popup_menu), menu_item);
437 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
442 gtk_menu_popup (GTK_MENU (priv->popup_menu), NULL, NULL,
443 popup_position_func, link_button,
445 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup_menu), FALSE);
451 gtk_link_button_button_press (GtkWidget *widget,
452 GdkEventButton *event)
454 if (!gtk_widget_has_focus (widget))
455 gtk_widget_grab_focus (widget);
457 if ((event->button == 3) && (event->type == GDK_BUTTON_PRESS))
459 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), event);
464 if (GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event)
465 return GTK_WIDGET_CLASS (gtk_link_button_parent_class)->button_press_event (widget, event);
471 gtk_link_button_clicked (GtkButton *button)
473 GtkLinkButton *link_button = GTK_LINK_BUTTON (button);
476 (* uri_func) (link_button, link_button->priv->uri, uri_func_data);
482 if (gtk_widget_has_screen (GTK_WIDGET (button)))
483 screen = gtk_widget_get_screen (GTK_WIDGET (button));
488 gtk_show_uri (screen, link_button->priv->uri, GDK_CURRENT_TIME, &error);
491 g_warning ("Unable to show '%s': %s",
492 link_button->priv->uri,
494 g_error_free (error);
498 gtk_link_button_set_visited (link_button, TRUE);
502 gtk_link_button_popup_menu (GtkWidget *widget)
504 gtk_link_button_do_popup (GTK_LINK_BUTTON (widget), NULL);
510 gtk_link_button_enter_cb (GtkWidget *widget,
511 GdkEventCrossing *crossing,
514 set_hand_cursor (widget, TRUE);
520 gtk_link_button_leave_cb (GtkWidget *widget,
521 GdkEventCrossing *crossing,
524 set_hand_cursor (widget, FALSE);
530 gtk_link_button_drag_data_get_cb (GtkWidget *widget,
531 GdkDragContext *context,
532 GtkSelectionData *selection,
537 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
540 uri = g_strdup_printf ("%s\r\n", link_button->priv->uri);
541 gtk_selection_data_set (selection,
551 * gtk_link_button_new:
554 * Creates a new #GtkLinkButton with the URI as its text.
556 * Return value: a new link button widget.
561 gtk_link_button_new (const gchar *uri)
563 gchar *utf8_uri = NULL;
566 g_return_val_if_fail (uri != NULL, NULL);
568 if (g_utf8_validate (uri, -1, NULL))
570 utf8_uri = g_strdup (uri);
574 GError *conv_err = NULL;
576 utf8_uri = g_locale_to_utf8 (uri, -1, NULL, NULL, &conv_err);
579 g_warning ("Attempting to convert URI `%s' to UTF-8, but failed "
583 g_error_free (conv_err);
585 utf8_uri = g_strdup (_("Invalid URI"));
589 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
600 * gtk_link_button_new_with_label:
602 * @label: (allow-none): the text of the button
604 * Creates a new #GtkLinkButton containing a label.
606 * Return value: (transfer none): a new link button widget.
611 gtk_link_button_new_with_label (const gchar *uri,
616 g_return_val_if_fail (uri != NULL, NULL);
619 return gtk_link_button_new (uri);
621 retval = g_object_new (GTK_TYPE_LINK_BUTTON,
630 gtk_link_button_query_tooltip_cb (GtkWidget *widget,
633 gboolean keyboard_tip,
637 GtkLinkButton *link_button = GTK_LINK_BUTTON (widget);
638 const gchar *label, *uri;
640 label = gtk_button_get_label (GTK_BUTTON (link_button));
641 uri = link_button->priv->uri;
643 if (!gtk_widget_get_tooltip_text (widget)
644 && !gtk_widget_get_tooltip_markup (widget)
645 && label && *label != '\0' && uri && strcmp (label, uri) != 0)
647 gtk_tooltip_set_text (tooltip, uri);
656 * gtk_link_button_set_uri:
657 * @link_button: a #GtkLinkButton
660 * Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
661 * this unsets the 'visited' state of the button.
666 gtk_link_button_set_uri (GtkLinkButton *link_button,
669 GtkLinkButtonPrivate *priv;
671 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
672 g_return_if_fail (uri != NULL);
674 priv = link_button->priv;
677 priv->uri = g_strdup (uri);
679 g_object_notify (G_OBJECT (link_button), "uri");
681 gtk_link_button_set_visited (link_button, FALSE);
685 * gtk_link_button_get_uri:
686 * @link_button: a #GtkLinkButton
688 * Retrieves the URI set using gtk_link_button_set_uri().
690 * Return value: a valid URI. The returned string is owned by the link button
691 * and should not be modified or freed.
695 G_CONST_RETURN gchar *
696 gtk_link_button_get_uri (GtkLinkButton *link_button)
698 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), NULL);
700 return link_button->priv->uri;
704 * gtk_link_button_set_uri_hook:
705 * @func: (allow-none): a function called each time a #GtkLinkButton is clicked, or %NULL
706 * @data: (allow-none): user data to be passed to @func, or %NULL
707 * @destroy: (allow-none): a #GDestroyNotify that gets called when @data is no longer needed, or %NULL
709 * Sets @func as the function that should be invoked every time a user clicks
710 * a #GtkLinkButton. This function is called before every callback registered
711 * for the "clicked" signal.
713 * If no uri hook has been set, GTK+ defaults to calling gtk_show_uri().
715 * Return value: the previously set hook function.
720 gtk_link_button_set_uri_hook (GtkLinkButtonUriFunc func,
722 GDestroyNotify destroy)
724 GtkLinkButtonUriFunc old_uri_func;
726 if (uri_func_destroy)
727 (* uri_func_destroy) (uri_func_data);
729 old_uri_func = uri_func;
732 uri_func_data = data;
733 uri_func_destroy = destroy;
739 * gtk_link_button_set_visited:
740 * @link_button: a #GtkLinkButton
741 * @visited: the new 'visited' state
743 * Sets the 'visited' state of the URI where the #GtkLinkButton
744 * points. See gtk_link_button_get_visited() for more details.
749 gtk_link_button_set_visited (GtkLinkButton *link_button,
752 g_return_if_fail (GTK_IS_LINK_BUTTON (link_button));
754 visited = visited != FALSE;
756 if (link_button->priv->visited != visited)
758 link_button->priv->visited = visited;
760 set_link_color (link_button);
762 g_object_notify (G_OBJECT (link_button), "visited");
767 * gtk_link_button_get_visited:
768 * @link_button: a #GtkLinkButton
770 * Retrieves the 'visited' state of the URI where the #GtkLinkButton
771 * points. The button becomes visited when it is clicked. If the URI
772 * is changed on the button, the 'visited' state is unset again.
774 * The state may also be changed using gtk_link_button_set_visited().
776 * Return value: %TRUE if the link has been visited, %FALSE otherwise
781 gtk_link_button_get_visited (GtkLinkButton *link_button)
783 g_return_val_if_fail (GTK_IS_LINK_BUTTON (link_button), FALSE);
785 return link_button->priv->visited;