Struct gio::ThemedIcon

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

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.

Properties

name

The icon name.

Writeable | Construct Only

names

A None-terminated array of icon names.

Readable | Writeable | Construct Only

use-default-fallbacks

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

⚠️ The following code is in C ⚠️

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

Readable | Writeable | Construct Only

Implements

glib::ObjectExt, IconExt

Implementations

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 from_names(iconnames: &[&str]) -> ThemedIcon

Creates a new themed icon for iconnames.

iconnames

an array of strings containing icon names.

Returns

a new ThemedIcon

pub fn 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:

⚠️ The following code is in C ⚠️

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

iconname

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

pub fn 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 g_icon_hash().

iconname

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

pub fn uses_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

⚠️ The following code is in C ⚠️

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

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

Trait Implementations

impl Clone for ThemedIcon

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 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 HasParamSpec for ThemedIcon

type ParamSpec = ParamSpecObject

type SetValue = ThemedIcon

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ThemedIcon

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 ThemedIcon

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 ThemedIcon

type Parent = Object

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

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 ThemedIcon

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 ThemedIcon

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ThemedIcon

impl IsA<Icon> for ThemedIcon