|
gtkmm 3.3.16
|
RecentChooser is an interface that can be implemented by widgets displaying the list of recently used files. More...

Public Types | |
| typedef sigc::slot< int, const Glib::RefPtr< RecentInfo > &, const Glib::RefPtr < RecentInfo >& > | SlotCompare |
| This callback should return -1 if b compares before a, 0 if they compare equal and 1 if a compares after b. | |
Public Member Functions | |
| virtual | ~RecentChooser () |
| GtkRecentChooser* | gobj () |
| Provides access to the underlying C GObject. | |
| const GtkRecentChooser* | gobj () const |
| Provides access to the underlying C GObject. | |
| void | set_show_private (bool show_private=true) |
| Whether to show recently used resources marked registered as private. | |
| bool | get_show_private () const |
| Returns whether chooser should display recently used resources registered as private. | |
| void | set_show_not_found (bool show_not_found=true) |
| Sets whether chooser should display the recently used resources that it didn't find. | |
| bool | get_show_not_found () const |
| Retrieves whether chooser should show the recently used resources that were not found. | |
| void | set_select_multiple (bool select_multiple=true) |
| Sets whether chooser can select multiple items. | |
| bool | get_select_multiple () const |
| Gets whether chooser can select multiple items. | |
| void | set_limit (int limit) |
| Sets the number of items that should be returned by get_items() and get_uris(). | |
| void | unset_limit () |
| int | get_limit () const |
| Gets the number of items returned by get_items() and get_uris(). | |
| void | set_local_only (bool local_only=true) |
| Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. | |
| bool | get_local_only () const |
| Gets whether only local resources should be shown in the recently used resources selector. | |
| void | set_show_tips (bool show_tips=true) |
| Sets whether to show a tooltips containing the full path of each recently used resource in a Gtk::RecentChooser widget. | |
| bool | get_show_tips () const |
| Gets whether chooser should display tooltips containing the full path of a recently user resource. | |
| void | set_show_icons (bool show_icons=true) |
| Sets whether chooser should show an icon near the resource when displaying it. | |
| bool | get_show_icons () const |
| Retrieves whether chooser should show an icon near the resource. | |
| void | set_sort_type (RecentSortType sort_type) |
| Changes the sorting order of the recently used resources list displayed by chooser. | |
| RecentSortType | get_sort_type () const |
| Gets the value set by set_sort_type(). | |
| void | set_sort_func (const SlotCompare& slot) |
| Sets the comparison function used when sorting the list of recently used resources and the sort type is RECENT_SORT_CUSTOM. | |
| bool | set_current_uri (const Glib::ustring& uri) |
| Sets uri as the current URI for chooser. | |
| Glib::ustring | get_current_uri () const |
| Gets the URI currently selected by chooser. | |
| Glib::RefPtr< RecentInfo > | get_current_item () |
| Gets the Gtk::RecentInfo currently selected by chooser. | |
| Glib::RefPtr< const RecentInfo > | get_current_item () const |
| Gets the Gtk::RecentInfo currently selected by chooser. | |
| bool | select_uri (const Glib::ustring& uri) |
| Selects uri inside chooser. | |
| void | unselect_uri (const Glib::ustring& uri) |
| Unselects uri inside chooser. | |
| void | select_all () |
| Selects all the items inside chooser, if the chooser supports multiple selection. | |
| void | unselect_all () |
| Unselects all the items inside chooser. | |
| std::vector< Glib::RefPtr < RecentInfo > > | get_items () const |
| Gets the list of recently used resources in form of Gtk::RecentInfo objects. | |
| std::vector< Glib::ustring > | get_uris () const |
| Gets the URI of the recently used resources. | |
| void | add_filter (const Glib::RefPtr< RecentFilter >& filter) |
| Adds filter to the list of Gtk::RecentFilter objects held by chooser. | |
| void | remove_filter (const Glib::RefPtr< RecentFilter >& filter) |
| Removes filter from the list of Gtk::RecentFilter objects held by chooser. | |
| std::vector< Glib::RefPtr < RecentFilter > > | list_filters () |
| Gets the Gtk::RecentFilter objects held by chooser. | |
| std::vector< Glib::RefPtr < const RecentFilter > > | list_filters () const |
| Gets the Gtk::RecentFilter objects held by chooser. | |
| void | set_filter (const Glib::RefPtr< RecentFilter >& filter) |
| Sets filter as the current Gtk::RecentFilter object used by chooser to affect the displayed recently used resources. | |
| Glib::RefPtr< RecentFilter > | get_filter () |
| Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources. | |
| Glib::RefPtr< const RecentFilter > | get_filter () const |
| Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources. | |
| Glib::SignalProxy0< void > | signal_selection_changed () |
| Glib::SignalProxy0< void > | signal_item_activated () |
| Glib::PropertyProxy< bool > | property_show_private () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_show_private () const |
| Whether the private items should be displayed. | |
| Glib::PropertyProxy< bool > | property_show_tips () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_show_tips () const |
| Whether there should be a tooltip on the item. | |
| Glib::PropertyProxy< bool > | property_show_icons () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_show_icons () const |
| Whether there should be an icon near the item. | |
| Glib::PropertyProxy< bool > | property_show_not_found () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_show_not_found () const |
| Whether the items pointing to unavailable resources should be displayed. | |
| Glib::PropertyProxy< bool > | property_select_multiple () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_select_multiple () const |
| Whether to allow multiple items to be selected. | |
| Glib::PropertyProxy< bool > | property_local_only () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < bool > | property_local_only () const |
| Whether the selected resource(s) should be limited to local file: URIs. | |
| Glib::PropertyProxy< int > | property_limit () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly< int > | property_limit () const |
| The maximum number of items to be displayed. | |
| Glib::PropertyProxy < RecentSortType > | property_sort_type () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < RecentSortType > | property_sort_type () const |
| The sorting order of the items displayed. | |
| Glib::PropertyProxy < Glib::RefPtr< RecentFilter > > | property_filter () |
| You rarely need to use properties because there are get_ and set_ methods for almost all of them. | |
| Glib::PropertyProxy_ReadOnly < Glib::RefPtr< RecentFilter > > | property_filter () const |
| The current filter for selecting which resources are displayed. | |
Static Public Member Functions | |
| static void | add_interface (GType gtype_implementer) |
Protected Member Functions | |
| virtual Glib::ustring | get_current_uri_vfunc () const |
| virtual void | unselect_uri_vfunc (const Glib::ustring& uri) |
| virtual void | select_all_vfunc () |
| virtual void | unselect_all_vfunc () |
| virtual Glib::RefPtr < RecentManager > | get_recent_manager_vfunc () |
| virtual void | add_filter_vfunc (const Glib::RefPtr< RecentFilter >& filter) |
| virtual void | remove_filter_vfunc (const Glib::RefPtr< RecentFilter >& filter) |
| virtual void | on_selection_changed () |
| This is a default handler for the signal signal_selection_changed(). | |
| virtual void | on_item_activated () |
| This is a default handler for the signal signal_item_activated(). | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr< Gtk::RecentChooser > | wrap (GtkRecentChooser* object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
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 RecentChooserWidget, RecentChooserDialog and RecentChooserMenu.
| typedef sigc::slot<int, const Glib::RefPtr<RecentInfo>&, const Glib::RefPtr<RecentInfo>&> Gtk::RecentChooser::SlotCompare |
This callback should return -1 if b compares before a, 0 if they compare equal and 1 if a compares after b.
For instance, int on_sort_compare(const Glib::RefPtr<Gtk::RecentInfo>& a, const Gtk::RecentInfo& b);
| virtual Gtk::RecentChooser::~RecentChooser | ( | ) | [virtual] |
| void Gtk::RecentChooser::add_filter | ( | const Glib::RefPtr< RecentFilter >& | filter | ) |
Adds filter to the list of Gtk::RecentFilter objects held by chooser.
If no previous filter objects were defined, this function will call set_filter().
| filter | A Gtk::RecentFilter. |
| virtual void Gtk::RecentChooser::add_filter_vfunc | ( | const Glib::RefPtr< RecentFilter >& | filter | ) | [protected, virtual] |
| static void Gtk::RecentChooser::add_interface | ( | GType | gtype_implementer | ) | [static] |
| Glib::RefPtr<RecentInfo> Gtk::RecentChooser::get_current_item | ( | ) |
Gets the Gtk::RecentInfo currently selected by chooser.
| Glib::RefPtr<const RecentInfo> Gtk::RecentChooser::get_current_item | ( | ) | const |
Gets the Gtk::RecentInfo currently selected by chooser.
| Glib::ustring Gtk::RecentChooser::get_current_uri | ( | ) | const |
Gets the URI currently selected by chooser.
| virtual Glib::ustring Gtk::RecentChooser::get_current_uri_vfunc | ( | ) | const [protected, virtual] |
| Glib::RefPtr<RecentFilter> Gtk::RecentChooser::get_filter | ( | ) |
Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources.
| Glib::RefPtr<const RecentFilter> Gtk::RecentChooser::get_filter | ( | ) | const |
Gets the Gtk::RecentFilter object currently used by chooser to affect the display of the recently used resources.
| std::vector<Glib::RefPtr<RecentInfo> > Gtk::RecentChooser::get_items | ( | ) | const |
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.
| int Gtk::RecentChooser::get_limit | ( | ) | const |
Gets the number of items returned by get_items() and get_uris().
| bool Gtk::RecentChooser::get_local_only | ( | ) | const |
Gets whether only local resources should be shown in the recently used resources selector.
See set_local_only()
true if only local resources should be shown. | virtual Glib::RefPtr<RecentManager> Gtk::RecentChooser::get_recent_manager_vfunc | ( | ) | [protected, virtual] |
| bool Gtk::RecentChooser::get_select_multiple | ( | ) | const |
Gets whether chooser can select multiple items.
true if chooser can select more than one item. | bool Gtk::RecentChooser::get_show_icons | ( | ) | const |
Retrieves whether chooser should show an icon near the resource.
true if the icons should be displayed, false otherwise. | bool Gtk::RecentChooser::get_show_not_found | ( | ) | const |
Retrieves whether chooser should show the recently used resources that were not found.
true if the resources not found should be displayed, and false otheriwse. | bool Gtk::RecentChooser::get_show_private | ( | ) | const |
Returns whether chooser should display recently used resources registered as private.
true if the recent chooser should show private items, false otherwise. | bool Gtk::RecentChooser::get_show_tips | ( | ) | const |
Gets whether chooser should display tooltips containing the full path of a recently user resource.
true if the recent chooser should show tooltips, false otherwise. | RecentSortType Gtk::RecentChooser::get_sort_type | ( | ) | const |
| std::vector<Glib::ustring> Gtk::RecentChooser::get_uris | ( | ) | const |
Gets the URI of the recently used resources.
The return value of this function is affected by the "sort-type" and "limit" properties of the recent chooser.
| GtkRecentChooser* Gtk::RecentChooser::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
Reimplemented in Gtk::RecentAction, Gtk::RecentChooserDialog, Gtk::RecentChooserMenu, and Gtk::RecentChooserWidget.
| const GtkRecentChooser* Gtk::RecentChooser::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
Reimplemented in Gtk::RecentAction, Gtk::RecentChooserDialog, Gtk::RecentChooserMenu, and Gtk::RecentChooserWidget.
| std::vector< Glib::RefPtr<RecentFilter> > Gtk::RecentChooser::list_filters | ( | ) |
Gets the Gtk::RecentFilter objects held by chooser.
| std::vector< Glib::RefPtr<const RecentFilter> > Gtk::RecentChooser::list_filters | ( | ) | const |
Gets the Gtk::RecentFilter objects held by chooser.
| virtual void Gtk::RecentChooser::on_item_activated | ( | ) | [protected, virtual] |
This is a default handler for the signal signal_item_activated().
| virtual void Gtk::RecentChooser::on_selection_changed | ( | ) | [protected, virtual] |
This is a default handler for the signal signal_selection_changed().
| Glib::PropertyProxy< Glib::RefPtr<RecentFilter> > Gtk::RecentChooser::property_filter | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr<RecentFilter> > Gtk::RecentChooser::property_filter | ( | ) | const |
The current filter for selecting which resources are displayed.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< int > Gtk::RecentChooser::property_limit | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< int > Gtk::RecentChooser::property_limit | ( | ) | const |
The maximum number of items to be displayed.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_local_only | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_local_only | ( | ) | const |
Whether the selected resource(s) should be limited to local file: URIs.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_select_multiple | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_select_multiple | ( | ) | const |
Whether to allow multiple items to be selected.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_show_icons | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_show_icons | ( | ) | const |
Whether there should be an icon near the item.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_show_not_found | ( | ) | const |
Whether the items pointing to unavailable resources should be displayed.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_show_not_found | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_show_private | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_show_private | ( | ) | const |
Whether the private items should be displayed.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Gtk::RecentChooser::property_show_tips | ( | ) | const |
Whether there should be a tooltip on the item.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< bool > Gtk::RecentChooser::property_show_tips | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy< RecentSortType > Gtk::RecentChooser::property_sort_type | ( | ) |
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< RecentSortType > Gtk::RecentChooser::property_sort_type | ( | ) | const |
The sorting order of the items displayed.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| void Gtk::RecentChooser::remove_filter | ( | const Glib::RefPtr< RecentFilter >& | filter | ) |
Removes filter from the list of Gtk::RecentFilter objects held by chooser.
| filter | A Gtk::RecentFilter. |
| virtual void Gtk::RecentChooser::remove_filter_vfunc | ( | const Glib::RefPtr< RecentFilter >& | filter | ) | [protected, virtual] |
| void Gtk::RecentChooser::select_all | ( | ) |
Selects all the items inside chooser, if the chooser supports multiple selection.
| virtual void Gtk::RecentChooser::select_all_vfunc | ( | ) | [protected, virtual] |
| bool Gtk::RecentChooser::select_uri | ( | const Glib::ustring & | uri | ) |
| bool Gtk::RecentChooser::set_current_uri | ( | const Glib::ustring & | uri | ) |
Sets uri as the current URI for chooser.
| uri | A URI. |
true if the URI was found. | void Gtk::RecentChooser::set_filter | ( | const Glib::RefPtr< RecentFilter >& | filter | ) |
Sets filter as the current Gtk::RecentFilter object used by chooser to affect the displayed recently used resources.
| filter | A Gtk::RecentFilter. |
| void Gtk::RecentChooser::set_limit | ( | int | limit | ) |
Sets the number of items that should be returned by get_items() and get_uris().
| limit | A positive integer, or -1 for all items. |
| void Gtk::RecentChooser::set_local_only | ( | bool | local_only = true | ) |
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.
| local_only | true if only local files can be shown. |
| void Gtk::RecentChooser::set_select_multiple | ( | bool | select_multiple = true | ) |
Sets whether chooser can select multiple items.
| select_multiple | true if chooser can select more than one item. |
| void Gtk::RecentChooser::set_show_icons | ( | bool | show_icons = true | ) |
Sets whether chooser should show an icon near the resource when displaying it.
| show_icons | Whether to show an icon near the resource. |
| void Gtk::RecentChooser::set_show_not_found | ( | bool | show_not_found = true | ) |
Sets whether chooser should display the recently used resources that it didn't find.
This only applies to local resources.
| show_not_found | Whether to show the local items we didn't find. |
| void Gtk::RecentChooser::set_show_private | ( | bool | show_private = true | ) |
Whether to show recently used resources marked registered as private.
| show_private | true to show private items, false otherwise. |
| void Gtk::RecentChooser::set_show_tips | ( | bool | show_tips = true | ) |
Sets whether to show a tooltips containing the full path of each recently used resource in a Gtk::RecentChooser widget.
| show_tips | true if tooltips should be shown. |
| void Gtk::RecentChooser::set_sort_func | ( | const SlotCompare & | slot | ) |
Sets the comparison function used when sorting the list of recently used resources and the sort type is RECENT_SORT_CUSTOM.
| void Gtk::RecentChooser::set_sort_type | ( | RecentSortType | sort_type | ) |
Changes the sorting order of the recently used resources list displayed by chooser.
| sort_type | Sort order that the chooser should use. |
| Glib::SignalProxy0< void > Gtk::RecentChooser::signal_item_activated | ( | ) |
void on_my_item_activated()This signal is emitted when the user "activates" a recent item in the recent chooser. This can happen by double-clicking on an item in the recently used resources list, or by pressing <keycap>Enter</keycap>.
| Glib::SignalProxy0< void > Gtk::RecentChooser::signal_selection_changed | ( | ) |
void on_my_selection_changed()This signal is emitted when there is a change in the set of selected recently used resources. This can happen when a user modifies the selection with the mouse or the keyboard, or when explicitely calling functions to change the selection.
| void Gtk::RecentChooser::unselect_all | ( | ) |
Unselects all the items inside chooser.
| virtual void Gtk::RecentChooser::unselect_all_vfunc | ( | ) | [protected, virtual] |
| void Gtk::RecentChooser::unselect_uri | ( | const Glib::ustring & | uri | ) |
| virtual void Gtk::RecentChooser::unselect_uri_vfunc | ( | const Glib::ustring & | uri | ) | [protected, virtual] |
| void Gtk::RecentChooser::unset_limit | ( | ) |
| Glib::RefPtr< Gtk::RecentChooser > wrap | ( | GtkRecentChooser * | object, |
| bool | take_copy = false |
||
| ) | [related] |
A Glib::wrap() method for this object.
| object | The C instance. |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
1.7.4