Struct gtk4::IconTheme[][src]

pub struct IconTheme(_);
Expand description

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

Implements

glib::ObjectExt

Implementations

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.

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.

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

Appends a directory to the search path.

See set_search_path().

path

directory name to append to the icon path

Returns the display that the IconTheme object was created for.

Returns

the display of icon_theme

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

Gets the current resource path.

See set_resource_path().

Returns

A list of resource paths or None. The returned value should be freed with g_strfreev().

Gets the current search path.

See set_search_path().

Returns

a list of icon theme path directories or None. The returned value should be freed with g_strfreev().

Gets the current icon theme name.

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

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.

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

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.

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

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 [type_funcGtk.get_for_display].

theme_name

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

The display that this icon theme object is attached to.

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.

Emitted when the icon theme changes.

This can happen becuase current icon theme is switched or because GTK detects that a change has occurred in the contents of the current icon theme.

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.