Struct gtk4::IconTheme

source ·

#[repr(transparent)]
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);

Struct gtk4::IconTheme

Implementations§

impl IconTheme

pub fn new() -> IconTheme

pub fn builder() -> IconThemeBuilder

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

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

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

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

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

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

pub fn theme_name(&self) -> GString

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

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

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

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

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

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

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

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

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

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: &str) -> Vec<i32>

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 Display for IconTheme

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

impl Hash for IconTheme

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

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

impl Ord for IconTheme

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

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

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

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

impl ParentClassIs for IconTheme

type Parent = Object

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

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

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

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

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

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

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

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

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

impl StaticType for IconTheme

fn static_type() -> Type

impl Eq for IconTheme

Auto Trait Implementations§

impl RefUnwindSafe for IconTheme

impl !Send for IconTheme

impl !Sync for IconTheme

impl Unpin for IconTheme

impl UnwindSafe for IconTheme

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for Twhere T: ObjectType,

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

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

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

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

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

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

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

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

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) -> Selfwhere
Self: Sized,

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

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

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

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

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

impl<T> Cast for Twhere
T: ObjectType,

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

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

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

fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<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) -> Twhere
T: ObjectType,

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

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for Twhere
T: ObjectType,

fn is<U>(&self) -> boolwhere
U: StaticType,

fn class(&self) -> &Class<T>where
T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,

fn set_property<V>(&self, property_name: &str, value: V)where
V: ToValue,

fn property<V>(&self, property_name: &str) -> Vwhere
V: 'static + for<'b> FromValue<'b>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,