Struct gio::ThemedIcon

pub struct ThemedIcon(_, _);

ThemedIcon is an implementation of Icon that supports icon themes. ThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. ThemedIcon does not provide actual pixmaps for icons, just the icon names. Ideally something like gtk_icon_theme_choose_icon should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes.

Implements

glib::object::ObjectExt, IconExt

Methods

impl ThemedIcon

pub fn new(iconname: &str) -> ThemedIcon

Creates a new themed icon for iconname.

iconname

a string containing an icon name.

Returns

a new ThemedIcon.

pub fn new_from_names(iconnames: &[&str]) -> ThemedIcon

Creates a new themed icon for iconnames.

iconnames

an array of strings containing icon names.

len

the length of the iconnames array, or -1 if iconnames is None-terminated

Returns

a new ThemedIcon

pub fn new_with_default_fallbacks(iconname: &str) -> ThemedIcon

Creates a new themed icon for iconname, and all the names that can be created by shortening iconname at '-' characters.

In the following example, icon1 and icon2 are equivalent:

const char *names[] = {
  "gnome-dev-cdrom-audio",
  "gnome-dev-cdrom",
  "gnome-dev",
  "gnome"
};

icon1 = g_themed_icon_new_from_names (names, 4);
icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");

iconname

a string containing an icon name

Returns

a new ThemedIcon.

pub fn append_name(&self, iconname: &str)

Append a name to the list of icons from within self.

Note that doing so invalidates the hash computed by prior calls to Icon::hash.

iconname

name of icon to append to list of icons from within self.

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

Gets the names of icons from within self.

Returns

a list of icon names.

pub fn prepend_name(&self, iconname: &str)

Prepend a name to the list of icons from within self.

Note that doing so invalidates the hash computed by prior calls to Icon::hash.

iconname

name of icon to prepend to list of icons from within self.

pub fn get_property_use_default_fallbacks(&self) -> bool

Whether to use the default fallbacks found by shortening the icon name at '-' characters. If the "names" array has more than one element, ignores any past the first.

For example, if the icon name was "gnome-dev-cdrom-audio", the array would become

{
  "gnome-dev-cdrom-audio",
  "gnome-dev-cdrom",
  "gnome-dev",
  "gnome",
  NULL
};

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

Trait Implementations

impl Clone for ThemedIcon

fn clone(&self) -> ThemedIcon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThemedIcon

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

Formats the value using the given formatter.

impl Display for ThemedIcon

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

Formats the value using the given formatter.

impl Eq for ThemedIcon

impl Hash for ThemedIcon

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl IsA<Icon> for ThemedIcon

impl Ord for ThemedIcon

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for ThemedIcon

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for ThemedIcon

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 ThemedIcon

fn static_type() -> Type

Returns the type identifier of Self.