Module: Gtk::RecentChooser
- Defined in:
- (unknown)
Overview
Gtk::RecentChooser 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 Gtk::RecentChooserWidget, Gtk::RecentChooserDialog and #GtkRecentChooserMenu.
Recently used files are supported since GTK+ 2.10.
Instance Method Summary collapse
- #add_filter(chooser, filter) ⇒ nil
-
#current_item ⇒ Gtk::RecentInfo
Gets the Gtk::RecentInfo currently selected by chooser.
-
#current_uri ⇒ String
Gets the URI currently selected by chooser.
-
#current_uri=(uri) ⇒ TrueClass
Sets uri as the current URI for chooser.
-
#filter ⇒ Gtk::RecentFilter
Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources.
-
#filter=(filter) ⇒ nil
Sets filter as the current Gtk::RecentFilter object used by chooser to affect the displayed recently used resources.
-
#get_current_uri(chooser) ⇒ String
A newly allocated string holding a URI.
-
#get_items(chooser) ⇒ GLib::List
A newly allocated list of Gtk::RecentInfo objects.
- #get_recent_manager(chooser) ⇒ Gtk::RecentManager
-
#get_uris(length) ⇒ Array<String>
Gets the URI of the recently used resources.
- #item_activated(chooser) ⇒ nil
-
#items ⇒ GLib::List
Gets the list of recently used resources in form of Gtk::RecentInfo objects.
-
#limit ⇒ Integer
Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
-
#limit=(limit) ⇒ nil
Sets the number of items that should be returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
-
#list_filters(chooser) ⇒ GLib::SList
A singly linked list of Gtk::RecentFilter objects.
-
#local_only ⇒ TrueClass
Gets whether only local resources should be shown in the recently used resources selector.
-
#local_only=(local_only) ⇒ nil
Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector.
- #recent_manager ⇒ Gtk::RecentManager
- #remove_filter(chooser, filter) ⇒ nil
- #select_all(chooser) ⇒ nil
-
#select_multiple ⇒ TrueClass
Gets whether chooser can select multiple items.
-
#select_multiple=(select_multiple) ⇒ nil
Sets whether chooser can select multiple items.
-
#select_uri(chooser, uri) ⇒ TrueClass
True if uri was found.
- #selection_changed(chooser) ⇒ nil
-
#set_current_uri(chooser, uri) ⇒ TrueClass
True if the URI was found.
- #set_sort_func(chooser, sort_func, sort_data, data_destroy) ⇒ nil
-
#show_icons ⇒ TrueClass
Retrieves whether chooser should show an icon near the resource.
-
#show_icons=(show_icons) ⇒ nil
Sets whether chooser should show an icon near the resource when displaying it.
-
#show_not_found ⇒ TrueClass
Retrieves whether chooser should show the recently used resources that were not found.
-
#show_not_found=(show_not_found) ⇒ nil
Sets whether chooser should display the recently used resources that it didn’t find.
-
#show_private ⇒ TrueClass
Returns whether chooser should display recently used resources registered as private.
-
#show_private=(show_private) ⇒ nil
Whether to show recently used resources marked registered as private.
-
#show_tips ⇒ TrueClass
Gets whether chooser should display tooltips containing the full path of a recently user resource.
-
#show_tips=(show_tips) ⇒ nil
Sets whether to show a tooltips containing the full path of each recently used resource in a Gtk::RecentChooser widget.
-
#sort_type ⇒ Gtk::RecentSortType
Gets the value set by gtk_recent_chooser_set_sort_type().
-
#sort_type=(sort_type) ⇒ nil
Changes the sorting order of the recently used resources list displayed by chooser.
- #unselect_all(chooser) ⇒ nil
- #unselect_uri(chooser, uri) ⇒ nil
Instance Method Details
#add_filter(chooser, filter) ⇒ nil
#current_item ⇒ Gtk::RecentInfo
Gets the Gtk::RecentInfo currently selected by chooser.
#current_uri ⇒ String
Gets the URI currently selected by chooser.
#current_uri=(uri) ⇒ TrueClass
Sets uri as the current URI for chooser.
#filter ⇒ Gtk::RecentFilter
Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources.
#filter=(filter) ⇒ nil
Sets filter as the current Gtk::RecentFilter object used by chooser to affect the displayed recently used resources.
#get_current_uri(chooser) ⇒ String
Returns a newly allocated string holding a URI.
#get_items(chooser) ⇒ GLib::List
Returns A newly allocated list of Gtk::RecentInfo objects. You should use gtk_recent_info_unref() on every item of the list, and then free the list itself using g_list_free().
#get_recent_manager(chooser) ⇒ Gtk::RecentManager
#get_uris(length) ⇒ Array<String>
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 nil terminated, length may be nil.
#item_activated(chooser) ⇒ nil
#items ⇒ GLib::List
Gets the list of recently used resources in form of Gtk::RecentInfo objects.
The return value of this function is affected by the “sort-type” and “limit” properties of chooser.
#limit ⇒ Integer
Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
#limit=(limit) ⇒ nil
Sets the number of items that should be returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
#list_filters(chooser) ⇒ GLib::SList
Returns A singly linked list of Gtk::RecentFilter objects. You should just free the returned list using g_slist_free().
#local_only ⇒ TrueClass
Gets whether only local resources should be shown in the recently used resources selector. See gtk_recent_chooser_set_local_only()
#local_only=(local_only) ⇒ nil
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.
#recent_manager ⇒ Gtk::RecentManager
#remove_filter(chooser, filter) ⇒ nil
#select_all(chooser) ⇒ nil
#select_multiple ⇒ TrueClass
Gets whether chooser can select multiple items.
#select_multiple=(select_multiple) ⇒ nil
Sets whether chooser can select multiple items.
#select_uri(chooser, uri) ⇒ TrueClass
Returns true if uri was found.
#selection_changed(chooser) ⇒ nil
#set_current_uri(chooser, uri) ⇒ TrueClass
Returns true if the URI was found.
#set_sort_func(chooser, sort_func, sort_data, data_destroy) ⇒ nil
#show_icons ⇒ TrueClass
Retrieves whether chooser should show an icon near the resource.
#show_icons=(show_icons) ⇒ nil
Sets whether chooser should show an icon near the resource when displaying it.
#show_not_found ⇒ TrueClass
Retrieves whether chooser should show the recently used resources that were not found.
#show_not_found=(show_not_found) ⇒ nil
Sets whether chooser should display the recently used resources that it didn’t find. This only applies to local resources.
#show_private ⇒ TrueClass
Returns whether chooser should display recently used resources registered as private.
#show_private=(show_private) ⇒ nil
Whether to show recently used resources marked registered as private.
#show_tips ⇒ TrueClass
Gets whether chooser should display tooltips containing the full path of a recently user resource.
#show_tips=(show_tips) ⇒ nil
Sets whether to show a tooltips containing the full path of each recently used resource in a Gtk::RecentChooser widget.
#sort_type ⇒ Gtk::RecentSortType
Gets the value set by gtk_recent_chooser_set_sort_type().
#sort_type=(sort_type) ⇒ nil
Changes the sorting order of the recently used resources list displayed by chooser.