]> Pileus Git - ~andy/gtk/blob - gtk/gtkappchooser.c
Add appchooser docs
[~andy/gtk] / gtk / gtkappchooser.c
1 /*
2  * gtkappchooser.c: app-chooser interface
3  *
4  * Copyright (C) 2010 Red Hat, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public License as
8  * published by the Free Software Foundation; either version 2 of the
9  * License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
18  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  *
21  * Authors: Cosimo Cecchi <ccecchi@redhat.com>
22  */
23
24 /**
25  * SECTION:gtkappchooser
26  * @Title: GtkAppChooser
27  * @Short_description: Interface implemented by widgets allowing to chooser applications
28  *
29  * #GtkAppChooser is an interface that can be implemented by widgets which
30  * allow the user to choose an application (typically for the purpose of
31  * opening a file). The main objects that implement this interface are
32  * #GtkAppChooserWidget, #GtkAppChooserDialog and #GtkAppChooserButton.
33  */
34
35 #include "config.h"
36
37 #include "gtkappchooser.h"
38
39 #include "gtkintl.h"
40 #include "gtkappchooserprivate.h"
41 #include "gtkwidget.h"
42
43 #include <glib.h>
44
45 G_DEFINE_INTERFACE (GtkAppChooser, gtk_app_chooser, GTK_TYPE_WIDGET);
46
47 static void
48 gtk_app_chooser_default_init (GtkAppChooserIface *iface)
49 {
50   GParamSpec *pspec;
51
52   /**
53    * GtkAppChooser:content-type:
54    *
55    * The content type of the #GtkAppChooser object.
56    */
57   pspec = g_param_spec_string ("content-type",
58                                P_("Content type"),
59                                P_("The content type used by the open with object"),
60                                NULL,
61                                G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE |
62                                G_PARAM_STATIC_STRINGS);
63   g_object_interface_install_property (iface, pspec);
64 }
65
66
67 /**
68  * gtk_app_chooser_get_content_type:
69  * @self: a #GtkAppChooser
70  *
71  * Returns the current value of the #GtkAppChooser:content-type property.
72  *
73  * Returns: the content type of @self. Free with g_free()
74  *
75  * Since: 3.0
76  */
77 gchar *
78 gtk_app_chooser_get_content_type (GtkAppChooser *self)
79 {
80   gchar *retval = NULL;
81
82   g_return_val_if_fail (GTK_IS_APP_CHOOSER (self), NULL);
83
84   g_object_get (self,
85                 "content-type", &retval,
86                 NULL);
87
88   return retval;
89 }
90
91 /**
92  * gtk_app_chooser_get_app_info:
93  * @self: a #GtkAppChooser
94  *
95  * Returns the currently selected application.
96  *
97  * Returns: (transfer full): a #GAppInfo for the currently selected
98  *     application, or %NULL if none is selected. Free with g_object_unref()
99  *
100  * Since: 3.0
101  */
102 GAppInfo *
103 gtk_app_chooser_get_app_info (GtkAppChooser *self)
104 {
105   return GTK_APP_CHOOSER_GET_IFACE (self)->get_app_info (self);
106 }
107
108 /**
109  * gtk_app_chooser_refresh:
110  * @self: a #GtkAppChooser
111  *
112  * Reloads the list of applications.
113  *
114  * Since: 3.0
115  */
116 void
117 gtk_app_chooser_refresh (GtkAppChooser *self)
118 {
119   GTK_APP_CHOOSER_GET_IFACE (self)->refresh (self);
120 }