Struct gtk4::IconTheme

source ·

pub struct IconTheme { /* private fields */ }

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

§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

[trait@glib::ObjectExt]

Struct gtk4::IconThemeCopy item path

§Properties

§display

§icon-names

§resource-path

§search-path

§theme-name

§Signals

§changed

§Implements

Implementations§

impl IconTheme

pub fn new() -> IconTheme

§Returns

pub fn builder() -> IconThemeBuilder

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

§path

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

§path

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

§Returns

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

§Returns

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

§Returns

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

§Returns

pub fn theme_name(&self) -> GString

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

§gicon

§Returns

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

§icon_name

§Returns

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

§icon

§size

§scale

§direction

§flags

§Returns

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

§icon_name

§size

§scale

§direction

§flags

§Returns

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

§path

pub fn set_search_path(&self, path: &[&Path])

§path

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

§theme_name

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

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

§display

§Returns

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

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>

§icon_name

§Returns

Trait Implementations§

impl Clone for IconTheme

fn clone(&self) -> Self

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

impl Debug for IconTheme

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

impl Default for IconTheme

fn default() -> Self

impl HasParamSpec for IconTheme

type ParamSpec = ParamSpecObject

type SetValue = IconTheme

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

Struct gtk4::IconTheme

§`display`

§`icon-names`

§`resource-path`

§`search-path`

§`theme-name`

§`changed`

§`path`

§`path`

§`gicon`

§`icon_name`

§`icon`

§`size`

§`scale`

§`direction`

§`flags`

§`icon_name`

§`size`

§`scale`

§`direction`

§`flags`

§`path`

§`path`

§`theme_name`

§`display`

§`icon_name`

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

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

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

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

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

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> Cast for T
where T: ObjectType,

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,