gtkmm: Gtk::RecentInfo Class Reference
Contains information found when looking up an entry of the recently used files list. More...
#include <gtkmm/recentinfo.h>
Public Member Functions | |
void | reference () const |
Increment the reference count for this object. More... | |
void | unreference () const |
Decrement the reference count for this object. More... | |
GtkRecentInfo* | gobj () |
Provides access to the underlying C instance. More... | |
const GtkRecentInfo* | gobj () const |
Provides access to the underlying C instance. More... | |
GtkRecentInfo* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
RecentInfo ()=delete | |
RecentInfo (const RecentInfo&)=delete | |
RecentInfo& | operator= (const RecentInfo&)=delete |
Glib::ustring | get_uri () const |
Gets the URI of the resource. More... | |
Glib::ustring | get_display_name () const |
Gets the name of the resource. More... | |
Glib::ustring | get_description () const |
Gets the (short) description of the resource. More... | |
Glib::ustring | get_mime_type () const |
Gets the MIME type of the resource. More... | |
Glib::DateTime | get_added () const |
Gets the the time when the resource was added to the recently used resources list. More... | |
Glib::DateTime | get_modified () const |
Gets the time when the meta-data for the resource was last modified. More... | |
Glib::DateTime | get_visited () const |
Gets the time when the meta-data for the resource was last visited. More... | |
bool | get_private_hint () const |
Gets the value of the “private” flag. More... | |
Glib::RefPtr< Gio::AppInfo > | create_app_info (const Glib::ustring& app_name) |
Creates a Gio::AppInfo for the specified Gtk::RecentInfo. More... | |
bool | get_application_info (const Glib::ustring& app_name, std::string& app_exec, guint&count, Glib::DateTime& stamp) const |
Gets the data regarding the application that has registered the resource pointed by info. More... | |
std::vector< Glib::ustring > | get_applications () const |
Retrieves the list of applications that have registered this resource. More... | |
Glib::ustring | last_application () const |
Gets the name of the last application that have registered the recently used resource represented by info. More... | |
bool | has_application (const Glib::ustring& app_name) const |
Checks whether an application registered this resource using app_name. More... | |
std::vector< Glib::ustring > | get_groups () const |
Returns all groups registered for the recently used item info. More... | |
bool | has_group (const Glib::ustring& group_name) const |
Checks whether group_name appears inside the groups registered for the recently used item info. More... | |
Glib::RefPtr< Gio::Icon > | get_gicon () |
Retrieves the icon associated to the resource MIME type. More... | |
Glib::RefPtr< const Gio::Icon > | get_gicon () const |
Retrieves the icon associated to the resource MIME type. More... | |
Glib::ustring | get_short_name () const |
Computes a valid UTF-8 string that can be used as the name of the item in a menu or list. More... | |
Glib::ustring | get_uri_display () const |
Gets a displayable version of the resource’s URI. More... | |
int | get_age () const |
Gets the number of days elapsed since the last update of the resource pointed by info. More... | |
bool | is_local () const |
Checks whether the resource is local or not by looking at the scheme of its URI. More... | |
bool | exists () const |
Checks whether the resource pointed by info still exists. More... | |
bool | equal (const Glib::RefPtr< const RecentInfo >& info_b) const |
Checks whether two Gtk::RecentInfo point to the same resource. More... | |
Protected Member Functions | |
void | operator delete (void*, std::size_t) |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator== (const Glib::RefPtr< const RecentInfo >& lhs, const Glib::RefPtr< const RecentInfo >& rhs) |
bool | operator!= (const Glib::RefPtr< const RecentInfo >& lhs, const Glib::RefPtr< const RecentInfo >& rhs) |
Glib::RefPtr< Gtk::RecentInfo > | wrap (GtkRecentInfo* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
Contains information found when looking up an entry of the recently used files list.
Constructor & Destructor Documentation
|
delete |
|
delete |
Member Function Documentation
Glib::RefPtr<Gio::AppInfo> Gtk::RecentInfo::create_app_info | ( | const Glib::ustring & | app_name | ) |
Creates a Gio::AppInfo for the specified Gtk::RecentInfo.
- Parameters
-
app_name The name of the application that should be mapped to a Gio::AppInfo; if nullptr
is used then the default application for the MIME type is used.
- Returns
- The newly created Gio::AppInfo, or
nullptr
. In case of error, error will be set either with a GTK_RECENT_MANAGER_ERROR or a G_IO_ERROR.
- Exceptions
-
Glib::Error
bool Gtk::RecentInfo::equal | ( | const Glib::RefPtr< const RecentInfo >& | info_b | ) | const |
Checks whether two Gtk::RecentInfo point to the same resource.
- Parameters
-
info_b A Gtk::RecentInfo.
- Returns
true
if both Gtk::RecentInfo point to the same resource,false
otherwise.
bool Gtk::RecentInfo::exists | ( | ) | const |
Checks whether the resource pointed by info still exists.
At the moment this check is done only on resources pointing to local files.
- Returns
true
if the resource exists.
Glib::DateTime Gtk::RecentInfo::get_added | ( | ) | const |
Gets the the time when the resource was added to the recently used resources list.
- Returns
- A DateTime for the time when the resource was added.
int Gtk::RecentInfo::get_age | ( | ) | const |
Gets the number of days elapsed since the last update of the resource pointed by info.
- Returns
- A positive integer containing the number of days elapsed since the time this resource was last modified.
bool Gtk::RecentInfo::get_application_info | ( | const Glib::ustring & | app_name, |
std::string & | app_exec, | ||
guint & | count, | ||
Glib::DateTime & | stamp | ||
) | const |
Gets the data regarding the application that has registered the resource pointed by info.
If the command line contains any escape characters defined inside the storage specification, they will be expanded.
- Parameters
-
app_name The name of the application that has registered this item. app_exec Return location for the string containing the command line. count Return location for the number of times this item was registered. stamp Return location for the time this item was last registered for this application.
- Returns
true
if an application with app_name has registered this resource inside the recently used list, orfalse
otherwise. The app_exec string is owned by the Gtk::RecentInfo and should not be modified or freed.
std::vector<Glib::ustring> Gtk::RecentInfo::get_applications | ( | ) | const |
Retrieves the list of applications that have registered this resource.
- Parameters
-
length Return location for the length of the returned list.
- Returns
- A newly allocated
nullptr
-terminated array of strings.
Glib::ustring Gtk::RecentInfo::get_description | ( | ) | const |
Gets the (short) description of the resource.
- Returns
- The description of the resource. The returned string is owned by the recent manager, and should not be freed.
Glib::ustring Gtk::RecentInfo::get_display_name | ( | ) | const |
Gets the name of the resource.
If none has been defined, the basename of the resource is obtained.
- Returns
- The display name of the resource. The returned string is owned by the recent manager, and should not be freed.
Glib::RefPtr<Gio::Icon> Gtk::RecentInfo::get_gicon | ( | ) |
Retrieves the icon associated to the resource MIME type.
- Returns
- A Gio::Icon containing the icon, or
nullptr
. Use Glib::object_unref() when finished using the icon.
Glib::RefPtr<const Gio::Icon> Gtk::RecentInfo::get_gicon | ( | ) | const |
Retrieves the icon associated to the resource MIME type.
- Returns
- A Gio::Icon containing the icon, or
nullptr
. Use Glib::object_unref() when finished using the icon.
std::vector<Glib::ustring> Gtk::RecentInfo::get_groups | ( | ) | const |
Returns all groups registered for the recently used item info.
The array of returned group names will be nullptr
terminated, so length might optionally be nullptr
.
- Parameters
-
length Return location for the number of groups returned.
- Returns
- A newly allocated
nullptr
terminated array of strings.
Glib::ustring Gtk::RecentInfo::get_mime_type | ( | ) | const |
Gets the MIME type of the resource.
- Returns
- The MIME type of the resource. The returned string is owned by the recent manager, and should not be freed.
Glib::DateTime Gtk::RecentInfo::get_modified | ( | ) | const |
Gets the time when the meta-data for the resource was last modified.
- Returns
- A DateTime for the time when the resource was last modified.
bool Gtk::RecentInfo::get_private_hint | ( | ) | const |
Gets the value of the “private” flag.
Resources in the recently used list that have this flag set to true
should only be displayed by the applications that have registered them.
- Returns
true
if the private flag was found,false
otherwise.
Glib::ustring Gtk::RecentInfo::get_short_name | ( | ) | const |
Computes a valid UTF-8 string that can be used as the name of the item in a menu or list.
For example, calling this function on an item that refers to “file:///foo/bar.txt” will yield “bar.txt”.
- Returns
- A newly-allocated string in UTF-8 encoding free it with Glib::free().
Glib::ustring Gtk::RecentInfo::get_uri | ( | ) | const |
Gets the URI of the resource.
- Returns
- The URI of the resource. The returned string is owned by the recent manager, and should not be freed.
Glib::ustring Gtk::RecentInfo::get_uri_display | ( | ) | const |
Gets a displayable version of the resource’s URI.
If the resource is local, it returns a local path; if the resource is not local, it returns the UTF-8 encoded content of get_uri().
- Returns
- A newly allocated UTF-8 string containing the resource’s URI or
nullptr
.
Glib::DateTime Gtk::RecentInfo::get_visited | ( | ) | const |
Gets the time when the meta-data for the resource was last visited.
- Returns
- A DateTime for the time when the resource was last visited.
GtkRecentInfo* Gtk::RecentInfo::gobj | ( | ) |
Provides access to the underlying C instance.
const GtkRecentInfo* Gtk::RecentInfo::gobj | ( | ) | const |
Provides access to the underlying C instance.
GtkRecentInfo* Gtk::RecentInfo::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gtk::RecentInfo::has_application | ( | const Glib::ustring & | app_name | ) | const |
Checks whether an application registered this resource using app_name.
- Parameters
-
app_name A string containing an application name.
- Returns
true
if an application with name app_name was found,false
otherwise.
bool Gtk::RecentInfo::has_group | ( | const Glib::ustring & | group_name | ) | const |
Checks whether group_name appears inside the groups registered for the recently used item info.
- Parameters
-
group_name Name of a group.
- Returns
true
if the group was found.
bool Gtk::RecentInfo::is_local | ( | ) | const |
Checks whether the resource is local or not by looking at the scheme of its URI.
- Returns
true
if the resource is local.
Glib::ustring Gtk::RecentInfo::last_application | ( | ) | const |
Gets the name of the last application that have registered the recently used resource represented by info.
- Returns
- An application name.
|
protected |
|
delete |
void Gtk::RecentInfo::reference | ( | ) | const |
Increment the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
void Gtk::RecentInfo::unreference | ( | ) | const |
Decrement the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
Friends And Related Function Documentation
|
related |
|
related |
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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.
- Returns
- A C++ instance that wraps this C instance.