gtkmm 4.17.0
|
Looking up icons by name. More...
#include <gtkmm/icontheme.h>
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static Glib::RefPtr< IconTheme > | create () |
static Glib::RefPtr< IconTheme > | get_for_display (const Glib::RefPtr< Gdk::Display > &display) |
Gets the icon theme object associated with display. | |
Protected Member Functions | |
IconTheme () | |
![]() | |
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 Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gtk::IconTheme > | wrap (GtkIconTheme *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
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 IconPaintable 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_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.
See set_resource_path().
This function should be used to make application-specific icons available as part of the icon theme.
path | A resource path. |
void Gtk::IconTheme::add_search_path | ( | const std::string & | path | ) |
Appends a directory to the search path.
See set_search_path().
path | Directory name to append to the icon path. |
|
static |
Glib::RefPtr< Gdk::Display > Gtk::IconTheme::get_display | ( | ) |
Returns the display that the Gtk::IconTheme
object was created for.
Glib::RefPtr< const Gdk::Display > Gtk::IconTheme::get_display | ( | ) | const |
Returns the display that the Gtk::IconTheme
object was created for.
|
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 new() and setting the display yourself; by using this function a single icon theme object will be shared between users.
display | A Gdk::Display . |
Gtk::IconTheme
associated with the given display. This icon theme is associated with the display and can be used as long as the display is open. Do not ref or unref it. std::vector< Glib::ustring > Gtk::IconTheme::get_icon_names | ( | ) | const |
Lists the names of icons in the current icon theme.
std::vector< int > Gtk::IconTheme::get_icon_sizes | ( | const Glib::ustring & | icon_name | ) | const |
Returns an array of integers describing the sizes at which the icon is available without scaling.
A size of -1 means that the icon is available in a scalable format. The array is zero-terminated.
icon_name | The name of an icon. |
std::vector< std::string > Gtk::IconTheme::get_resource_path | ( | ) | const |
std::vector< std::string > Gtk::IconTheme::get_search_path | ( | ) | const |
Glib::ustring Gtk::IconTheme::get_theme_name | ( | ) | const |
Gets the current icon theme name.
|
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_gicon | ( | const Glib::RefPtr< const Gio::Icon > & | gicon | ) | const |
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 self includes an icon for icon_name. Glib::RefPtr< IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a icon for a desired size and window scale.
The icon can then be rendered by using it as a Gdk::Paintable
, or you can get information such as the filename and size.
icon | The Gio::Icon to look up. |
size | Desired icon size, in application pixels. |
scale | The desired scale. |
direction | Text direction the icon will be displayed in. |
flags | Flags modifying the behavior of the icon lookup. |
Gtk::IconPaintable
containing information about the icon. Unref with Glib::object_unref(). Glib::RefPtr< const IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::RefPtr< const Gio::Icon > & | icon, |
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a icon for a desired size and window scale.
The icon can then be rendered by using it as a Gdk::Paintable
, or you can get information such as the filename and size.
icon | The Gio::Icon to look up. |
size | Desired icon size, in application pixels. |
scale | The desired scale. |
direction | Text direction the icon will be displayed in. |
flags | Flags modifying the behavior of the icon lookup. |
Gtk::IconPaintable
containing information about the icon. Unref with Glib::object_unref(). Glib::RefPtr< IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
const std::vector< Glib::ustring > & | fallbacks, | ||
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
Looks up a named icon for a desired size and window scale, returning a Gtk::IconPaintable
.
The icon can then be rendered by using it as a Gdk::Paintable
, or you can get information such as the filename and size.
If the available icon_name is not available and fallbacks are provided, they will be tried in order.
If no matching icon is found, then a paintable that renders the "missing icon" icon is returned. If you need to do something else for missing icons you need to use has_icon().
Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.
icon_name | The name of the icon to lookup. |
fallbacks | Fallback names. |
size | Desired icon size, in application pixels. |
scale | The window scale this will be displayed on. |
direction | Text direction the icon will be displayed in. |
flags | Flags modifying the behavior of the icon lookup. |
Gtk::IconPaintable
object containing the icon. Glib::RefPtr< const IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
const std::vector< Glib::ustring > & | fallbacks, | ||
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
Looks up a named icon for a desired size and window scale, returning a Gtk::IconPaintable
.
The icon can then be rendered by using it as a Gdk::Paintable
, or you can get information such as the filename and size.
If the available icon_name is not available and fallbacks are provided, they will be tried in order.
If no matching icon is found, then a paintable that renders the "missing icon" icon is returned. If you need to do something else for missing icons you need to use has_icon().
Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.
icon_name | The name of the icon to lookup. |
fallbacks | Fallback names. |
size | Desired icon size, in application pixels. |
scale | The window scale this will be displayed on. |
direction | Text direction the icon will be displayed in. |
flags | Flags modifying the behavior of the icon lookup. |
Gtk::IconPaintable
object containing the icon. Glib::RefPtr< IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) |
A lookup_icon() convenience overload.
Glib::RefPtr< const IconPaintable > Gtk::IconTheme::lookup_icon | ( | const Glib::ustring & | icon_name, |
int | size, | ||
int | scale = 1 , |
||
TextDirection | direction = TextDirection::NONE , |
||
IconLookupFlags | flags = (IconLookupFlags) 0 |
||
) | const |
A lookup_icon() convenience overload.
Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > Gtk::IconTheme::property_display | ( | ) |
The display that this icon theme object is attached to.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > Gtk::IconTheme::property_display | ( | ) | const |
The display that this icon theme object is attached to.
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > Gtk::IconTheme::property_icon_names | ( | ) | const |
The icon names that are supported by the icon theme.
Glib::PropertyProxy< std::vector< std::string > > Gtk::IconTheme::property_resource_path | ( | ) |
Resource paths that will be looked at when looking for icons, similar to search paths.
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.
Glib::PropertyProxy_ReadOnly< std::vector< std::string > > Gtk::IconTheme::property_resource_path | ( | ) | const |
Resource paths that will be looked at when looking for icons, similar to search paths.
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.
Glib::PropertyProxy< std::vector< std::string > > Gtk::IconTheme::property_search_path | ( | ) |
The search path for this icon theme.
When looking for icons, GTK will search for a subdirectory of one or more of the directories in the search path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user’s home directory.)
Glib::PropertyProxy_ReadOnly< std::vector< std::string > > Gtk::IconTheme::property_search_path | ( | ) | const |
The search path for this icon theme.
When looking for icons, GTK will search for a subdirectory of one or more of the directories in the search path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user’s home directory.)
Glib::PropertyProxy< Glib::ustring > Gtk::IconTheme::property_theme_name | ( | ) |
The name of the icon theme that is being used.
Unless set to a different value, this will be the value of the GtkSettings:gtk-icon-theme-name
property of the Gtk::Settings
object associated to the display of the icontheme object.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::IconTheme::property_theme_name | ( | ) | const |
The name of the icon theme that is being used.
Unless set to a different value, this will be the value of the GtkSettings:gtk-icon-theme-name
property of the Gtk::Settings
object associated to the display of the icontheme object.
Default value: ""
void Gtk::IconTheme::set_resource_path | ( | const std::vector< std::string > & | path | ) |
Sets the resource paths that will be looked at when looking for icons, similar to search paths.
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
or @a path/scalable/actions/run.svg
.
Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback, but they are treated like unthemed icons.
path | nullptr -terminated array of resource paths that are searched for icons. |
void Gtk::IconTheme::set_search_path | ( | const std::vector< std::string > & | path | ) |
Sets the search path for the icon theme object.
When looking for an icon theme, GTK will search for a subdirectory of one or more of the directories in path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user’s home directory.)
In addition if an icon found isn’t found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of path, then that image will be used for the icon name. (This is legacy feature, and new icons should be put into the fallback icon theme, which is called hicolor, rather than directly on the icon path.)
path | nullptr -terminated array of directories that are searched for icon themes. |
void Gtk::IconTheme::set_theme_name | ( | 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_for_display().
theme_name | Name of icon theme to use instead of configured theme, or nullptr to unset a previously set custom theme. |
Glib::SignalProxy< void()> Gtk::IconTheme::signal_changed | ( | ) |
void on_my_changed()
Flags: Run Last
Emitted when the icon theme changes.
This can happen because current icon theme is switched or because 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. |