gtkshow.c 2.37 KB
Newer Older
1
/*
Cody Russell's avatar
Cody Russell committed
2
 * GTK - The GIMP Toolkit
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * Copyright (C) 2008  Jaap Haitsma <jaap@haitsma.org>
 *
 * All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

23
#include "config.h"
24

25
#include <gdk/gdk.h>
26 27 28 29 30

#include "gtkshow.h"

/**
 * gtk_show_uri:
Johan Dahlin's avatar
Johan Dahlin committed
31
 * @screen: (allow-none): screen to show the uri on or %NULL for the default screen
32
 * @uri: the uri to show
33
 * @timestamp: a timestamp to prevent focus stealing.
34 35
 * @error: a #GError that is returned in case of errors
 *
36
 * This is a convenience function for launching the default application
Matthias Clasen's avatar
Matthias Clasen committed
37
 * to show the uri. The uri must be of a form understood by GIO. Typical
38
 * examples are
Matthias Clasen's avatar
Matthias Clasen committed
39 40 41 42 43
 * <simplelist>
 *   <member><filename>file:///home/gnome/pict.jpg</filename></member>
 *   <member><filename>http://www.gnome.org</filename></member>
 *   <member><filename>mailto:me&commat;gnome.org</filename></member>
 * </simplelist>
44 45
 * Ideally the timestamp is taken from the event triggering
 * the gtk_show_uri() call. If timestamp is not known you can take
Matthias Clasen's avatar
Matthias Clasen committed
46 47
 * %GDK_CURRENT_TIME.
 *
48
 * This function can be used as a replacement for gnome_vfs_url_show()
Matthias Clasen's avatar
Matthias Clasen committed
49
 * and gnome_url_show().
50 51 52 53 54 55
 *
 * Returns: %TRUE on success, %FALSE on error.
 *
 * Since: 2.14
 */
gboolean
56 57 58
gtk_show_uri (GdkScreen    *screen,
              const gchar  *uri,
              guint32       timestamp,
Matthias Clasen's avatar
Matthias Clasen committed
59
              GError      **error)
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
{
  GdkAppLaunchContext *context;
  gboolean ret;

  g_return_val_if_fail (uri != NULL, FALSE);

  context = gdk_app_launch_context_new ();
  gdk_app_launch_context_set_screen (context, screen);
  gdk_app_launch_context_set_timestamp (context, timestamp);

  ret = g_app_info_launch_default_for_uri (uri, (GAppLaunchContext*)context, error);
  g_object_unref (context);

  return ret;
}