AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

appchooser: Convert docs

Browse Source
This commit is contained in:
Matthias Clasen 2021-02-26 23:14:20 -05:00 committed by Emmanuele Bassi
parent 465aca029e
commit 166edeed91
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
gtk/gtkappchooser.c
View File

@ -20,28 +20,27 @@
*/ */
/** /**
* SECTION:gtkappchooser * GtkAppChooser:
* @Title: GtkAppChooser
* @Short_description: Interface implemented by widgets for choosing an application
* @See_also: #GAppInfo
* *
* #GtkAppChooser is an interface that can be implemented by widgets which * `GtkAppChooser` is an interface for widgets which allow the user to
* allow the user to choose an application (typically for the purpose of * choose an application.
* opening a file). The main objects that implement this interface are
* #GtkAppChooserWidget, #GtkAppChooserDialog and #GtkAppChooserButton.
* *
* Applications are represented by GIO #GAppInfo objects here. * The main objects that implement this interface are
* [class@Gtk.AppChooserWidget],
* [class@Gtk.AppChooserDialog] and [class@Gtk.AppChooserButton].
*
* Applications are represented by GIO `GAppInfo` objects here.
* GIO has a concept of recommended and fallback applications for a * GIO has a concept of recommended and fallback applications for a
* given content type. Recommended applications are those that claim * given content type. Recommended applications are those that claim
* to handle the content type itself, while fallback also includes * to handle the content type itself, while fallback also includes
* applications that handle a more generic content type. GIO also * applications that handle a more generic content type. GIO also
* knows the default and last-used application for a given content * knows the default and last-used application for a given content
* type. The #GtkAppChooserWidget provides detailed control over * type. The `GtkAppChooserWidget` provides detailed control over
* whether the shown list of applications should include default, * whether the shown list of applications should include default,
* recommended or fallback applications. * recommended or fallback applications.
* *
* To obtain the application that has been selected in a #GtkAppChooser, * To obtain the application that has been selected in a `GtkAppChooser`,
* use gtk_app_chooser_get_app_info(). * use [method@Gtk.AppChooser.get_app_info].
*/ */
#include "config.h" #include "config.h"
@ -62,12 +61,11 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
GParamSpec *pspec; GParamSpec *pspec;
/** /**
* GtkAppChooser:content-type: * GtkAppChooser:content-type: (attributes org.gtk.Property.get=gtk_app_chooser_get_content_type)
* *
* The content type of the #GtkAppChooser object. * The content type of the `GtkAppChooser` object.
* *
* See [GContentType][gio-GContentType] * See `GContentType` for more information about content types.
* for more information about content types.
*/ */
pspec = g_param_spec_string ("content-type", pspec = g_param_spec_string ("content-type",
P_("Content type"), P_("Content type"),
@ -80,10 +78,11 @@ gtk_app_chooser_default_init (GtkAppChooserIface *iface)
/** /**
* gtk_app_chooser_get_content_type: * gtk_app_chooser_get_content_type: (attributes org.gtk.Method.get_property=content-type)
* @self: a #GtkAppChooser * @self: a `GtkAppChooser`
* *
* Returns the current value of the #GtkAppChooser:content-type property. * Returns the content type for which the `GtkAppChooser`
* shows applications.
* *
* Returns: the content type of @self. Free with g_free() * Returns: the content type of @self. Free with g_free()
*/ */
@ -103,12 +102,13 @@ gtk_app_chooser_get_content_type (GtkAppChooser *self)
/** /**
* gtk_app_chooser_get_app_info: * gtk_app_chooser_get_app_info:
* @self: a #GtkAppChooser * @self: a `GtkAppChooser`
* *
* Returns the currently selected application. * Returns the currently selected application.
* *
* Returns: (nullable) (transfer full): a #GAppInfo for the currently selected * Returns: (nullable) (transfer full): a `GAppInfo` for the
* application, or %NULL if none is selected. Free with g_object_unref() * currently selected application, or %NULL if none is selected.
* Free with g_object_unref()
*/ */
GAppInfo * GAppInfo *
gtk_app_chooser_get_app_info (GtkAppChooser *self) gtk_app_chooser_get_app_info (GtkAppChooser *self)
@ -118,7 +118,7 @@ gtk_app_chooser_get_app_info (GtkAppChooser *self)
/** /**
* gtk_app_chooser_refresh: * gtk_app_chooser_refresh:
* @self: a #GtkAppChooser * @self: a `GtkAppChooser`
* *
* Reloads the list of applications. * Reloads the list of applications.
*/ */