gtkmm
3.93.0
|
Looking up icons by name. More...
#include <gtkmm/icontheme.h>
Public Member Functions | |
IconTheme (IconTheme&& src) noexcept | |
IconTheme& | operator= (IconTheme&& src) noexcept |
~IconTheme () noexcept override | |
GtkIconTheme* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkIconTheme* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkIconTheme* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
void | set_display (const Glib::RefPtr< Gdk::Display >& display) |
Sets the display for an icon theme; the display is used to track the user’s currently configured icon theme, which might be different for different displays. More... | |
void | set_search_path (const std::vector< Glib::ustring >& path) |
std::vector< Glib::ustring > | get_search_path () const |
void | append_search_path (const Glib::ustring& path) |
Appends a directory to the search path. More... | |
void | prepend_search_path (const Glib::ustring& path) |
Prepends a directory to the search path. More... | |
void | add_resource_path (const std::string& path) |
Adds a resource path that will be looked at when looking for icons, similar to search paths. More... | |
void | set_custom_theme (const Glib::ustring& theme_name) |
Sets the name of the icon theme that the Gtk::IconTheme object uses overriding system configuration. More... | |
bool | has_icon (const Glib::ustring& icon_name) const |
Checks whether an icon theme includes an icon for a particular name. More... | |
std::vector< int > | get_icon_sizes (const Glib::ustring& icon_name) const |
Glib::RefPtr< IconInfo > | lookup_icon (const Glib::ustring& icon_name, int size, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up a named icon and returns a structure containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | lookup_icon (const Glib::ustring& icon_name, int size, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up a named icon and returns a structure containing information such as the filename of the icon. More... | |
Glib::RefPtr< IconInfo > | lookup_icon (const Glib::ustring& icon_name, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | lookup_icon (const Glib::ustring& icon_name, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< IconInfo > | lookup_icon (const Glib::RefPtr< const Gio::Icon >& icon, int size, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | lookup_icon (const Glib::RefPtr< const Gio::Icon >& icon, int size, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< IconInfo > | lookup_icon (const Glib::RefPtr< const Gio::Icon >& icon, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | lookup_icon (const Glib::RefPtr< const Gio::Icon >& icon, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< IconInfo > | choose_icon (const std::vector< Glib::ustring >& icon_names, int size, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up a named icon and returns a structure containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | choose_icon (const std::vector< Glib::ustring >& icon_names, int size, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up a named icon and returns a structure containing information such as the filename of the icon. More... | |
Glib::RefPtr< IconInfo > | choose_icon (const std::vector< Glib::ustring >& icon_names, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< const IconInfo > | choose_icon (const std::vector< Glib::ustring >& icon_names, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon. More... | |
Glib::RefPtr< const Gdk::Pixbuf > | load_icon (const Glib::ustring& icon_name, int size, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. More... | |
Glib::RefPtr< const Gdk::Pixbuf > | load_icon (const Glib::ustring& icon_name, int size, int scale, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a pixbuf. More... | |
Cairo::RefPtr< const Cairo::Surface > | load_surface (const Glib::ustring& icon_name, int size, int scale, const Glib::RefPtr< Gdk::Window >& for_window, IconLookupFlags flags=(IconLookupFlags) 0) const |
Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a cairo surface. More... | |
std::vector< Glib::ustring > | list_icons (const Glib::ustring& context) const |
Lists a subset of icons in the current icon theme, by providing a context string. More... | |
std::vector< Glib::ustring > | list_icons () const |
Lists the icons in the current icon theme. More... | |
std::vector< Glib::ustring > | list_contexts () const |
Gets the list of contexts available within the current hierarchy of icon themes. More... | |
Glib::ustring | get_example_icon_name () const |
Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.) More... | |
bool | rescan_if_needed () |
Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed. More... | |
Glib::SignalProxy< void()> | signal_changed () |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
![]() | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Glib::RefPtr< IconTheme > | create () |
static Glib::RefPtr< IconTheme > | get_default () |
Gets the icon theme for the default display. More... | |
static Glib::RefPtr< IconTheme > | get_for_display (const Glib::RefPtr< Gdk::Display >& display) |
Gets the icon theme object associated with display; if this function has not previously been called for the given display, a new icon theme object will be created and associated with the display. More... | |
Protected Member Functions | |
IconTheme () | |
virtual void | on_changed () |
This is a default handler for the signal signal_changed(). More... | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::IconTheme > | wrap (GtkIconTheme* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Looking up icons by name.
Gtk::IconTheme provides a facility for looking up icons by name and size. The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification. There is a fallback icon theme, named hicolor
, where applications should install their icons, but additional icon themes can be installed as operating system vendors and users choose.
In many cases, named themes are used indirectly, via Gtk::Image rather than directly, but looking up icons directly is also simple. The Gtk::IconTheme object acts as a database of all the icons in the current theme. You can create new Gtk::IconTheme objects, but it’s much more efficient to use the standard icon theme for the Gdk::Display so that the icon information is shared with other people looking up icons. Use get_default() or get_for_display().
|
noexcept |
|
overridenoexcept |
|
protected |
void Gtk::IconTheme::add_resource_path | ( | const std::string & | path | ) |
Adds a resource path that will be looked at when looking for icons, similar to search paths.
This function should be used to make application-specific icons available as part of the icon theme.
The resources are considered as part of the hicolor icon theme and must be located in subdirectories that are defined in the hicolor icon theme, such as @a path/16x16/actions/run.png
. Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback.
path | A resource path. |
void Gtk::IconTheme::append_search_path | ( | const Glib::ustring & | path | ) |
Appends a directory to the search path.
See set_search_path().
path | Directory name to append to the icon path. |
Glib::RefPtr<IconInfo> Gtk::IconTheme::choose_icon | ( | const std::vector< Glib::ustring > & | icon_names, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a named icon and returns a structure containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.
icon_names | Array of icon names to lookup. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
Glib::RefPtr<const IconInfo> Gtk::IconTheme::choose_icon | ( | const std::vector< Glib::ustring > & | icon_names, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a named icon and returns a structure containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.
icon_names | Array of icon names to lookup. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
Glib::RefPtr<IconInfo> Gtk::IconTheme::choose_icon | ( | const std::vector< Glib::ustring > & | icon_names, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.
icon_names | nullptr -terminated array of icon names to lookup. |
size | Desired icon size. |
scale | Desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Glib::RefPtr<const IconInfo> Gtk::IconTheme::choose_icon | ( | const std::vector< Glib::ustring > & | icon_names, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.
icon_names | nullptr -terminated array of icon names to lookup. |
size | Desired icon size. |
scale | Desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found.
|
static |
|
static |
Gets the icon theme for the default display.
See get_for_display().
Glib::ustring Gtk::IconTheme::get_example_icon_name | ( | ) | const |
Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.)
|
static |
Gets the icon theme object associated with display; if this function has not previously been called for the given display, a new icon theme object will be created and associated with the display.
Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling than new() and setting the display yourself; by using this function a single icon theme object will be shared between users.
display | A Gdk::Display. |
std::vector<int> Gtk::IconTheme::get_icon_sizes | ( | const Glib::ustring & | icon_name | ) | const |
std::vector<Glib::ustring> Gtk::IconTheme::get_search_path | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkIconTheme* Gtk::IconTheme::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gtk::IconTheme::has_icon | ( | const Glib::ustring & | icon_name | ) | const |
Checks whether an icon theme includes an icon for a particular name.
icon_name | The name of an icon. |
true
if icon_theme includes an icon for icon_name. std::vector<Glib::ustring> Gtk::IconTheme::list_contexts | ( | ) | const |
Gets the list of contexts available within the current hierarchy of icon themes.
std::vector<Glib::ustring> Gtk::IconTheme::list_icons | ( | const Glib::ustring & | context | ) | const |
Lists a subset of icons in the current icon theme, by providing a context string.
The set of values for the context string is system dependent, but will typically include such values as 'Applications' and 'MimeTypes'.
context | A string identifying a particular type of icon. |
std::vector<Glib::ustring> Gtk::IconTheme::list_icons | ( | ) | const |
Lists the icons in the current icon theme.
Glib::RefPtr<const Gdk::Pixbuf> Gtk::IconTheme::load_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf.
This is a convenience function; if more details about the icon are needed, use lookup_icon() followed by Gtk::IconInfo::load_icon().
Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using gdk_pixbuf_copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.
icon_name | The name of the icon to lookup. |
size | The desired icon size. The resulting icon may not be exactly this size; see Gtk::IconInfo::load_icon(). |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon isn’t found.Glib::Error |
Glib::RefPtr<const Gdk::Pixbuf> Gtk::IconTheme::load_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a pixbuf.
This is a convenience function; if more details about the icon are needed, use lookup_icon() followed by Gtk::IconInfo::load_icon().
Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using gdk_pixbuf_copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.
icon_name | The name of the icon to lookup. |
size | The desired icon size. The resulting icon may not be exactly this size; see Gtk::IconInfo::load_icon(). |
scale | Desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon isn’t found.Glib::Error |
Cairo::RefPtr<const Cairo::Surface> Gtk::IconTheme::load_surface | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale, | ||
const Glib::RefPtr< Gdk::Window >& | for_window, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a cairo surface.
This is a convenience function; if more details about the icon are needed, use lookup_icon() followed by Gtk::IconInfo::load_surface().
Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal.
icon_name | The name of the icon to lookup. |
size | The desired icon size. The resulting icon may not be exactly this size; see Gtk::IconInfo::load_icon(). |
scale | Desired scale. |
for_window | Gdk::Window to optimize drawing for, or nullptr . |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon isn’t found.Glib::Error |
Glib::RefPtr<IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a named icon and returns a structure containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
icon_name | The name of the icon to lookup. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
Glib::RefPtr<const IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a named icon and returns a structure containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
icon_name | The name of the icon to lookup. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
Glib::RefPtr<IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
icon_name | The name of the icon to lookup. |
size | Desired icon size. |
scale | The desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Glib::RefPtr<const IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a named icon for a particular window scale and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon(). (load_icon() combines these two steps if all you need is the pixbuf.)
icon_name | The name of the icon to lookup. |
size | Desired icon size. |
scale | The desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Glib::RefPtr<IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon().
When rendering on displays with high pixel densities you should not use a size multiplied by the scaling factor returned by functions like gdk_window_get_scale_factor(). Instead, you should use lookup_by_gicon_for_scale(), as the assets loaded for a given scaling factor may be different.
icon | The Gio::Icon to look up. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Unref with Glib::object_unref(). Glib::RefPtr<const IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon().
When rendering on displays with high pixel densities you should not use a size multiplied by the scaling factor returned by functions like gdk_window_get_scale_factor(). Instead, you should use lookup_by_gicon_for_scale(), as the assets loaded for a given scaling factor may be different.
icon | The Gio::Icon to look up. |
size | Desired icon size. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Unref with Glib::object_unref(). Glib::RefPtr<IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon().
icon | The Gio::Icon to look up. |
size | Desired icon size. |
scale | The desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Unref with Glib::object_unref(). Glib::RefPtr<const IconInfo> Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
int | scale, | ||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up an icon and returns a Gtk::IconInfo containing information such as the filename of the icon.
The icon can then be rendered into a pixbuf using Gtk::IconInfo::load_icon().
icon | The Gio::Icon to look up. |
size | Desired icon size. |
scale | The desired scale. |
flags | Flags modifying the behavior of the icon lookup. |
nullptr
if the icon wasn’t found. Unref with Glib::object_unref().
|
protectedvirtual |
This is a default handler for the signal signal_changed().
void Gtk::IconTheme::prepend_search_path | ( | const Glib::ustring & | path | ) |
Prepends a directory to the search path.
See set_search_path().
path | Directory name to prepend to the icon path. |
bool Gtk::IconTheme::rescan_if_needed | ( | ) |
Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed.
true
if the icon theme has changed and needed to be reloaded. void Gtk::IconTheme::set_custom_theme | ( | const Glib::ustring & | theme_name | ) |
Sets the name of the icon theme that the Gtk::IconTheme object uses overriding system configuration.
This function cannot be called on the icon theme objects returned from get_default() and get_for_display().
theme_name | Name of icon theme to use instead of configured theme, or nullptr to unset a previously set custom theme. |
void Gtk::IconTheme::set_display | ( | const Glib::RefPtr< Gdk::Display >& | display | ) |
Sets the display for an icon theme; the display is used to track the user’s currently configured icon theme, which might be different for different displays.
display | A Gdk::Display. |
void Gtk::IconTheme::set_search_path | ( | const std::vector< Glib::ustring > & | path | ) |
Glib::SignalProxy<void()> Gtk::IconTheme::signal_changed | ( | ) |
void on_my_changed()
Flags: Run Last
Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme.
|
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. |