diff options
| -rw-r--r-- | docs/reference/gtk/tmpl/.gitignore | 1 | ||||
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkrecentchooser.sgml | 442 | ||||
| -rw-r--r-- | gtk/gtkrecentchooser.c | 17 | ||||
| -rw-r--r-- | gtk/gtkrecentchooser.h | 21 |
4 files changed, 38 insertions, 443 deletions
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 0dc5174d59..5e0163b3af 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -9,6 +9,7 @@ gtkpagesetupunixdialog.sgml gtkprinter.sgml gtkradioaction.sgml gtkrecentaction.sgml +gtkrecentchooser.sgml gtkrecentchooserwidget.sgml gtkscalebutton.sgml gtkseparator.sgml diff --git a/docs/reference/gtk/tmpl/gtkrecentchooser.sgml b/docs/reference/gtk/tmpl/gtkrecentchooser.sgml deleted file mode 100644 index a491382395..0000000000 --- a/docs/reference/gtk/tmpl/gtkrecentchooser.sgml +++ /dev/null @@ -1,442 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GtkRecentChooser - -<!-- ##### SECTION Short_Description ##### --> -Interface implemented by widgets displaying recently used files - -<!-- ##### SECTION Long_Description ##### --> -<para> -#GtkRecentChooser is an interface that can be implemented by widgets -displaying the list of recently used files. In GTK+, the main objects -that implement this interface are #GtkRecentChooserWidget, -#GtkRecentChooserDialog and #GtkRecentChooserMenu. -</para> - -<para> -Recently used files are supported since GTK+ 2.10. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GtkRecentManager, #GtkRecentChooserDialog, #GtkRecentChooserWidget, -#GtkRecentChooserMenu -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT GtkRecentChooser ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GtkRecentChooser::item-activated ##### --> -<para> - -</para> - -@recentchooser: the object which received the signal. - -<!-- ##### SIGNAL GtkRecentChooser::selection-changed ##### --> -<para> - -</para> - -@recentchooser: the object which received the signal. - -<!-- ##### ARG GtkRecentChooser:filter ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:limit ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:local-only ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:recent-manager ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:select-multiple ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:show-icons ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:show-not-found ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:show-private ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:show-tips ##### --> -<para> - -</para> - -<!-- ##### ARG GtkRecentChooser:sort-type ##### --> -<para> - -</para> - -<!-- ##### STRUCT GtkRecentChooserIface ##### --> -<para> - -</para> - -@base_iface: -@set_current_uri: -@get_current_uri: -@select_uri: -@unselect_uri: -@select_all: -@unselect_all: -@get_items: -@get_recent_manager: -@add_filter: -@remove_filter: -@list_filters: -@set_sort_func: -@item_activated: -@selection_changed: - -<!-- ##### MACRO GTK_RECENT_CHOOSER_ERROR ##### --> -<para> -Used to get the #GError quark for #GtkRecentChooser errors. -</para> - - - -<!-- ##### ENUM GtkRecentChooserError ##### --> -<para> -These identify the various errors that can occur while calling -#GtkRecentChooser functions. -</para> - -@GTK_RECENT_CHOOSER_ERROR_NOT_FOUND: Indicates that a file does not exist -@GTK_RECENT_CHOOSER_ERROR_INVALID_URI: Indicates a malformed URI - -<!-- ##### FUNCTION gtk_recent_chooser_set_show_private ##### --> -<para> - -</para> - -@chooser: -@show_private: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_show_private ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_show_not_found ##### --> -<para> - -</para> - -@chooser: -@show_not_found: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_show_not_found ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_show_icons ##### --> -<para> - -</para> - -@chooser: -@show_icons: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_show_icons ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_select_multiple ##### --> -<para> - -</para> - -@chooser: -@select_multiple: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_select_multiple ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_local_only ##### --> -<para> - -</para> - -@chooser: -@local_only: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_local_only ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_limit ##### --> -<para> - -</para> - -@chooser: -@limit: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_limit ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_show_tips ##### --> -<para> - -</para> - -@chooser: -@show_tips: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_show_tips ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### ENUM GtkRecentSortType ##### --> -<para> - -</para> - -@GTK_RECENT_SORT_NONE: -@GTK_RECENT_SORT_MRU: -@GTK_RECENT_SORT_LRU: -@GTK_RECENT_SORT_CUSTOM: - -<!-- ##### FUNCTION gtk_recent_chooser_set_sort_type ##### --> -<para> - -</para> - -@chooser: -@sort_type: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_sort_type ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### USER_FUNCTION GtkRecentSortFunc ##### --> -<para> - -</para> - -@a: -@b: -@user_data: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_sort_func ##### --> -<para> - -</para> - -@chooser: -@sort_func: -@sort_data: -@data_destroy: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_current_uri ##### --> -<para> - -</para> - -@chooser: -@uri: -@error: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_current_uri ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_current_item ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_select_uri ##### --> -<para> - -</para> - -@chooser: -@uri: -@error: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_unselect_uri ##### --> -<para> - -</para> - -@chooser: -@uri: - - -<!-- ##### FUNCTION gtk_recent_chooser_select_all ##### --> -<para> - -</para> - -@chooser: - - -<!-- ##### FUNCTION gtk_recent_chooser_unselect_all ##### --> -<para> - -</para> - -@chooser: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_items ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_uris ##### --> -<para> - -</para> - -@chooser: -@length: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_add_filter ##### --> -<para> - -</para> - -@chooser: -@filter: - - -<!-- ##### FUNCTION gtk_recent_chooser_remove_filter ##### --> -<para> - -</para> - -@chooser: -@filter: - - -<!-- ##### FUNCTION gtk_recent_chooser_list_filters ##### --> -<para> - -</para> - -@chooser: -@Returns: - - -<!-- ##### FUNCTION gtk_recent_chooser_set_filter ##### --> -<para> - -</para> - -@chooser: -@filter: - - -<!-- ##### FUNCTION gtk_recent_chooser_get_filter ##### --> -<para> - -</para> - -@chooser: -@Returns: - - diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c index 71a5bcfcd8..d381df328a 100644 --- a/gtk/gtkrecentchooser.c +++ b/gtk/gtkrecentchooser.c @@ -33,6 +33,23 @@ #include "gtkalias.h" +/** + * SECTION:gtkrecentchooser + * @Short_description: Interface implemented by widgets displaying recently + * used files + * @Title: GtkRecentChooser + * @See_also: #GtkRecentManager, #GtkRecentChooserDialog, + * #GtkRecentChooserWidget, #GtkRecentChooserMenu + * + * #GtkRecentChooser is an interface that can be implemented by widgets + * displaying the list of recently used files. In GTK+, the main objects + * that implement this interface are #GtkRecentChooserWidget, + * #GtkRecentChooserDialog and #GtkRecentChooserMenu. + * + * Recently used files are supported since GTK+ 2.10. + */ + + enum { ITEM_ACTIVATED, diff --git a/gtk/gtkrecentchooser.h b/gtk/gtkrecentchooser.h index 8b891e1d51..f6494db691 100644 --- a/gtk/gtkrecentchooser.h +++ b/gtk/gtkrecentchooser.h @@ -50,7 +50,9 @@ G_BEGIN_DECLS * * Used to specify the sorting method to be applyed to the recently * used resource list. - **/ + * + * Since: 2.10 + */ typedef enum { GTK_RECENT_SORT_NONE = 0, @@ -67,8 +69,25 @@ typedef gint (*GtkRecentSortFunc) (GtkRecentInfo *a, typedef struct _GtkRecentChooser GtkRecentChooser; /* dummy */ typedef struct _GtkRecentChooserIface GtkRecentChooserIface; +/** + * GTK_RECENT_CHOOSER_ERROR: + * + * Used to get the #GError quark for #GtkRecentChooser errors. + * + * Since: 2.10 + */ #define GTK_RECENT_CHOOSER_ERROR (gtk_recent_chooser_error_quark ()) +/** + * GtkRecentChooserError: + * @GTK_RECENT_CHOOSER_ERROR_NOT_FOUND: Indicates that a file does not exist + * @GTK_RECENT_CHOOSER_ERROR_INVALID_URI: Indicates a malformed URI + * + * These identify the various errors that can occur while calling + * #GtkRecentChooser functions. + * + * Since: 2.10 + */ typedef enum { GTK_RECENT_CHOOSER_ERROR_NOT_FOUND, |