summaryrefslogtreecommitdiff
path: root/gtk/gtkshow.c
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2017-02-15 13:35:13 +0100
committerBastien Nocera <hadess@hadess.net>2017-02-15 16:33:01 +0100
commit22ea1a535e889c53dd29c75797a2553d41cae1cb (patch)
tree8dc595679d4296654bb1d44430c9f0e6e1afef36 /gtk/gtkshow.c
parent922156d05a219930dd43cc4ed83b75a27179f87f (diff)
downloadgtk+-22ea1a535e889c53dd29c75797a2553d41cae1cb.tar.gz
gtkshow: Prefer gtk_show_uri_on_window() which works for sandboxed apps
gtk_show_uri_on_window() will pass enough information for Portal helpers to allow dialogue parenting in Flatpak, gtk_show_uri() won't, so deprecate it. https://bugzilla.gnome.org/show_bug.cgi?id=778678
Diffstat (limited to 'gtk/gtkshow.c')
-rw-r--r--gtk/gtkshow.c35
1 files changed, 21 insertions, 14 deletions
diff --git a/gtk/gtkshow.c b/gtk/gtkshow.c
index 0a00e5a614..a20d53674c 100644
--- a/gtk/gtkshow.c
+++ b/gtk/gtkshow.c
@@ -33,18 +33,13 @@
* @timestamp: a timestamp to prevent focus stealing
* @error: a #GError that is returned in case of errors
*
- * This is a convenience function for launching the default application
- * to show the uri. The uri must be of a form understood by GIO (i.e. you
- * need to install gvfs to get support for uri schemes such as http://
- * or ftp://, as only local files are handled by GIO itself).
- * Typical examples are
- * - `file:///home/gnome/pict.jpg`
- * - `http://www.gnome.org`
- * - `mailto:me@gnome.org`
+ * A convenience function for launching the default application
+ * to show the uri. Like gtk_show_uri_on_window(), but takes a screen
+ * as transient parent instead of a window.
*
- * Ideally the timestamp is taken from the event triggering
- * the gtk_show_uri() call. If timestamp is not known you can take
- * %GDK_CURRENT_TIME.
+ * Note that this function is deprecated as it does not pass the necessary
+ * information for helpers to parent their dialog properly, when run from
+ * sandboxed applications for example.
*
* Returns: %TRUE on success, %FALSE on error
*
@@ -114,9 +109,21 @@ window_handle_exported (GtkWindow *window,
* @timestamp: a timestamp to prevent focus stealing
* @error: a #GError that is returned in case of errors
*
- * A convenience function for launching the default application
- * to show the uri. Like gtk_show_uri(), but takes a window
- * as transient parent instead of a screen.
+ * This is a convenience function for launching the default application
+ * to show the uri. The uri must be of a form understood by GIO (i.e. you
+ * need to install gvfs to get support for uri schemes such as http://
+ * or ftp://, as only local files are handled by GIO itself).
+ * Typical examples are
+ * - `file:///home/gnome/pict.jpg`
+ * - `http://www.gnome.org`
+ * - `mailto:me@gnome.org`
+ *
+ * Ideally the timestamp is taken from the event triggering
+ * the gtk_show_uri() call. If timestamp is not known you can take
+ * %GDK_CURRENT_TIME.
+ *
+ * This is the recommended call to be used as it passes information
+ * necessary for sandbox helpers to parent their dialogs properly.
*
* Returns: %TRUE on success, %FALSE on error
*