Struct gtk4::IconTheme

#[repr(transparent)]
pub struct IconTheme { /* private fields */ }

IconTheme provides a facility for loading themed icons.

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 Image rather than directly, but looking up icons directly is also simple. The IconTheme object acts as a database of all the icons in the current theme. You can create new IconTheme objects, but it’s much more efficient to use the standard icon theme of the Widget so that the icon information is shared with other people looking up icons.

⚠️ The following code is in c ⚠️

GtkIconTheme *icon_theme;
GtkIconPaintable *icon;
GdkPaintable *paintable;

icon_theme = gtk_icon_theme_get_for_display (gtk_widget_get_display (my_widget));
icon = gtk_icon_theme_lookup_icon (icon_theme,
                                   "my-icon-name", // icon name
                                   48, // icon size
                                   1,  // scale
                                   0,  // flags);
paintable = GDK_PAINTABLE (icon);
// Use the paintable
g_object_unref (icon);

Properties

display

The display that this icon theme object is attached to.

Readable | Writeable

icon-names

The icon names that are supported by the icon theme.

Readable

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 @path/16x16/actions/run.png. Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback.

Readable | Writeable

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.)

Readable | Writeable

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 Settings object associated to the display of the icontheme object.

Readable | Writeable

Signals

changed

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.

Implements

glib::ObjectExt

Implementations

impl IconTheme

pub fn new() -> IconTheme

Creates a new icon theme object.

Icon theme objects are used to lookup up an icon by name in a particular icon theme. Usually, you’ll want to use for_display() rather than creating a new icon theme object for scratch.

Returns

the newly created IconTheme object.

pub fn builder() -> IconThemeBuilder

Creates a new builder-pattern struct instance to construct IconTheme objects.

This method returns an instance of IconThemeBuilder which can be used to create IconTheme objects.

pub fn add_resource_path(&self, path: &str)

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

pub fn add_search_path(&self, path: impl AsRef<Path>)

Appends a directory to the search path.

See set_search_path().

path

directory name to append to the icon path

pub fn display(&self) -> Option<Display>

Returns the display that the IconTheme object was created for.

Returns

the display of @icon_theme

pub fn icon_names(&self) -> Vec<GString>

Lists the names of icons in the current icon theme.

Returns

a string array holding the names of all the icons in the theme. You must free the array using g_strfreev().

pub fn resource_path(&self) -> Vec<GString>

Gets the current resource path.

See set_resource_path().

Returns

A list of resource paths

pub fn search_path(&self) -> Vec<PathBuf>

Gets the current search path.

See set_search_path().

Returns

a list of icon theme path directories

pub fn theme_name(&self) -> GString

Gets the current icon theme name.

Returns (transfer full): the current icon theme name,

pub fn has_gicon(&self, gicon: &impl IsA<Icon>) -> bool

Available on crate feature v4_2 only.

Checks whether an icon theme includes an icon for a particular GIcon.

gicon

a GIcon

Returns

true if @self includes an icon for @gicon

pub fn has_icon(&self, icon_name: &str) -> bool

Checks whether an icon theme includes an icon for a particular name.

icon_name

the name of an icon

Returns

true if @self includes an icon for @icon_name.

pub fn lookup_by_gicon( &self, icon: &impl IsA<Icon>, size: i32, scale: i32, direction: TextDirection, flags: IconLookupFlags ) -> IconPaintable

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 GIcon to look up

size

desired icon size

scale

the desired scale

direction

text direction the icon will be displayed in

flags

flags modifying the behavior of the icon lookup

Returns

a IconPaintable containing information about the icon. Unref with g_object_unref()

pub fn lookup_icon( &self, icon_name: &str, fallbacks: &[&str], size: i32, scale: i32, direction: TextDirection, flags: IconLookupFlags ) -> IconPaintable

Looks up a named icon for a desired size and window scale, returning a 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

size

desired icon size.

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

Returns

a IconPaintable object containing the icon.

pub fn set_resource_path(&self, path: &[&str])

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 @path/16x16/actions/run.png or @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

NULL-terminated array of resource paths that are searched for icons

pub fn set_search_path(&self, path: &[&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

NULL-terminated array of directories that are searched for icon themes

pub fn set_theme_name(&self, theme_name: Option<&str>)

Sets the name of the icon theme that the IconTheme object uses overriding system configuration.

This function cannot be called on the icon theme objects returned from for_display().

theme_name

name of icon theme to use instead of configured theme, or None to unset a previously set custom theme

pub fn set_display<P: IsA<Display>>(&self, display: Option<&P>)

The display that this icon theme object is attached to.

pub fn for_display(display: &impl IsA<Display>) -> IconTheme

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

Returns

A unique 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.

pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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.

pub fn connect_display_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_icon_names_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_resource_path_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_search_path_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl IconTheme

pub fn icon_sizes(&self, icon_name: impl IntoGStr) -> Slice<i32>

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

Returns

A newly allocated array describing the sizes at which the icon is available. The array should be freed with g_free() when it is no longer needed.

Trait Implementations

impl Clone for IconTheme

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IconTheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IconTheme

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for IconTheme

type ParamSpec = ParamSpecObject

type SetValue = IconTheme

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, IconTheme>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IconTheme

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IconTheme

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for IconTheme

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for IconTheme

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for IconTheme

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for IconTheme

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IconTheme