| Top |
| GtkRecentChooser | |
| struct | GtkRecentChooserIface |
| #define | GTK_RECENT_CHOOSER_ERROR |
| enum | GtkRecentChooserError |
| enum | GtkRecentSortType |
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.
void gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser,gboolean show_private);
Whether to show recently used resources marked registered as private.
Since: 2.10
gboolean
gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser);
Returns whether chooser
should display recently used resources
registered as private.
Since: 2.10
void gtk_recent_chooser_set_show_not_found (GtkRecentChooser *chooser,gboolean show_not_found);
Sets whether chooser
should display the recently used resources that
it didn’t find. This only applies to local resources.
Since: 2.10
gboolean
gtk_recent_chooser_get_show_not_found (GtkRecentChooser *chooser);
Retrieves whether chooser
should show the recently used resources that
were not found.
Since: 2.10
void gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser,gboolean show_icons);
Sets whether chooser
should show an icon near the resource when
displaying it.
Since: 2.10
gboolean
gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser);
Retrieves whether chooser
should show an icon near the resource.
Since: 2.10
void gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser,gboolean select_multiple);
Sets whether chooser
can select multiple items.
Since: 2.10
gboolean
gtk_recent_chooser_get_select_multiple
(GtkRecentChooser *chooser);
Gets whether chooser
can select multiple items.
Since: 2.10
void gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser,gboolean local_only);
Sets whether only local resources, that is resources using the file:// URI
scheme, should be shown in the recently used resources selector. If
local_only
is TRUE (the default) then the shown resources are guaranteed
to be accessible through the operating system native file system.
Since: 2.10
gboolean
gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser);
Gets whether only local resources should be shown in the recently used
resources selector. See gtk_recent_chooser_set_local_only()
Since: 2.10
void gtk_recent_chooser_set_limit (GtkRecentChooser *chooser,gint limit);
Sets the number of items that should be returned by
gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
Since: 2.10
gint
gtk_recent_chooser_get_limit (GtkRecentChooser *chooser);
Gets the number of items returned by gtk_recent_chooser_get_items()
and gtk_recent_chooser_get_uris().
Since: 2.10
void gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser,gboolean show_tips);
Sets whether to show a tooltips containing the full path of each recently used resource in a GtkRecentChooser widget.
Since: 2.10
gboolean
gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser);
Gets whether chooser
should display tooltips containing the full path
of a recently user resource.
Since: 2.10
void gtk_recent_chooser_set_sort_type (GtkRecentChooser *chooser,GtkRecentSortType sort_type);
Changes the sorting order of the recently used resources list displayed by
chooser
.
Since: 2.10
GtkRecentSortType
gtk_recent_chooser_get_sort_type (GtkRecentChooser *chooser);
Gets the value set by gtk_recent_chooser_set_sort_type().
Since: 2.10
gint (*GtkRecentSortFunc) (GtkRecentInfo *a,GtkRecentInfo *b,gpointer user_data);
void gtk_recent_chooser_set_sort_func (GtkRecentChooser *chooser,GtkRecentSortFunc sort_func,gpointer sort_data,GDestroyNotify data_destroy);
Sets the comparison function used when sorting to be sort_func
. If
the chooser
has the sort type set to GTK_RECENT_SORT_CUSTOM then
the chooser will sort using this function.
To the comparison function will be passed two GtkRecentInfo structs and
sort_data
; sort_func
should return a positive integer if the first
item comes before the second, zero if the two items are equal and
a negative integer if the first item comes after the second.
Since: 2.10
gboolean gtk_recent_chooser_set_current_uri (GtkRecentChooser *chooser,const gchar *uri,GError **error);
Sets uri
as the current URI for chooser
.
Since: 2.10
gchar *
gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser);
Gets the URI currently selected by chooser
.
Since: 2.10
GtkRecentInfo *
gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser);
Gets the GtkRecentInfo currently selected by chooser
.
Since: 2.10
gboolean gtk_recent_chooser_select_uri (GtkRecentChooser *chooser,const gchar *uri,GError **error);
Selects uri
inside chooser
.
Since: 2.10
void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser,const gchar *uri);
Unselects uri
inside chooser
.
Since: 2.10
void
gtk_recent_chooser_select_all (GtkRecentChooser *chooser);
Selects all the items inside chooser
, if the chooser
supports
multiple selection.
Since: 2.10
void
gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser);
Unselects all the items inside chooser
.
Since: 2.10
GList *
gtk_recent_chooser_get_items (GtkRecentChooser *chooser);
Gets the list of recently used resources in form of GtkRecentInfo objects.
The return value of this function is affected by the “sort-type” and
“limit” properties of chooser
.
A newly allocated
list of GtkRecentInfo objects. You should
use gtk_recent_info_unref() on every item of the list, and then free
the list itself using g_list_free().
[element-type GtkRecentInfo][transfer full]
Since: 2.10
gchar ** gtk_recent_chooser_get_uris (GtkRecentChooser *chooser,gsize *length);
Gets the URI of the recently used resources.
The return value of this function is affected by the “sort-type” and “limit”
properties of chooser
.
Since the returned array is NULL terminated, length
may be NULL.
chooser |
||
length |
return location for a the length of the
URI list, or |
[out][allow-none] |
A newly allocated, NULL-terminated array of strings. Use
g_strfreev() to free it.
[array length=length zero-terminated=1][transfer full]
Since: 2.10
void gtk_recent_chooser_add_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Adds filter
to the list of GtkRecentFilter objects held by chooser
.
If no previous filter objects were defined, this function will call
gtk_recent_chooser_set_filter().
Since: 2.10
void gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Removes filter
from the list of GtkRecentFilter objects held by chooser
.
Since: 2.10
GSList *
gtk_recent_chooser_list_filters (GtkRecentChooser *chooser);
Gets the GtkRecentFilter objects held by chooser
.
A singly linked list
of GtkRecentFilter objects. You
should just free the returned list using g_slist_free().
[element-type GtkRecentFilter][transfer container]
Since: 2.10
void gtk_recent_chooser_set_filter (GtkRecentChooser *chooser,GtkRecentFilter *filter);
Sets filter
as the current GtkRecentFilter object used by chooser
to affect the displayed recently used resources.
Since: 2.10
GtkRecentFilter *
gtk_recent_chooser_get_filter (GtkRecentChooser *chooser);
Gets the GtkRecentFilter object currently used by chooser
to affect
the display of the recently used resources.
Since: 2.10
struct GtkRecentChooserIface {
/*
* Methods
*/
gboolean (* set_current_uri) (GtkRecentChooser *chooser,
const gchar *uri,
GError **error);
gchar * (* get_current_uri) (GtkRecentChooser *chooser);
gboolean (* select_uri) (GtkRecentChooser *chooser,
const gchar *uri,
GError **error);
void (* unselect_uri) (GtkRecentChooser *chooser,
const gchar *uri);
void (* select_all) (GtkRecentChooser *chooser);
void (* unselect_all) (GtkRecentChooser *chooser);
GList * (* get_items) (GtkRecentChooser *chooser);
GtkRecentManager *(* get_recent_manager) (GtkRecentChooser *chooser);
void (* add_filter) (GtkRecentChooser *chooser,
GtkRecentFilter *filter);
void (* remove_filter) (GtkRecentChooser *chooser,
GtkRecentFilter *filter);
GSList * (* list_filters) (GtkRecentChooser *chooser);
void (* set_sort_func) (GtkRecentChooser *chooser,
GtkRecentSortFunc sort_func,
gpointer sort_data,
GDestroyNotify data_destroy);
/*
* Signals
*/
void (* item_activated) (GtkRecentChooser *chooser);
void (* selection_changed) (GtkRecentChooser *chooser);
};
Sets uri as the current URI for chooser. |
||
Gets the URI currently selected by chooser. |
||
Selects uri inside chooser. |
||
Unselects uri inside chooser. |
||
Selects all the items inside chooser, if the chooser supports multiple selection. |
||
Unselects all the items inside chooser. |
||
Gets the list of recently used resources in form of GtkRecentInfo objects. |
||
Gets the GtkRecentManager used by chooser. |
||
Adds filter to the list of GtkRecentFilter objects held by chooser. |
||
Removes filter from the list of GtkRecentFilter objects held by chooser. |
||
Gets the GtkRecentFilter objects held by chooser. |
||
Sets the comparison function used when sorting to be sort_func. |
||
Signal emitted when the user “activates” a recent item in the recent chooser. |
||
Signal emitted when there is a change in the set of selected recently used resources. |
#define GTK_RECENT_CHOOSER_ERROR (gtk_recent_chooser_error_quark ())
Used to get the GError quark for GtkRecentChooser errors.
Since: 2.10
These identify the various errors that can occur while calling GtkRecentChooser functions.
Since: 2.10
Used to specify the sorting method to be applyed to the recently used resource list.
|
Do not sort the returned list of recently used resources. |
||
|
Sort the returned list with the most recently used items first. |
||
|
Sort the returned list with the least recently used items first. |
||
|
Sort the returned list using a custom sorting
function passed using |
Since: 2.10