Struct gio::Icon

pub struct Icon { /* private fields */ }

Icon is a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and serializing an icon to and from strings.

Icon does not provide the actual pixmap for the icon as this is out of GIO’s scope, however implementations of Icon may contain the name of an icon (see ThemedIcon), or the path to an icon (see LoadableIcon).

To obtain a hash of a Icon, see g_icon_hash().

To check if two GIcons are equal, see g_icon_equal().

For serializing a Icon, use IconExt::serialize() and deserialize().

If you want to consume Icon (for example, in a toolkit) you must be prepared to handle at least the three following cases: LoadableIcon, ThemedIcon and EmblemedIcon. It may also make sense to have fast-paths for other cases (like handling GdkPixbuf directly, for example) but all compliant Icon implementations outside of GIO must implement LoadableIcon.

If your application or library provides one or more Icon implementations you need to ensure that your new implementation also implements LoadableIcon. Additionally, you must provide an implementation of IconExt::serialize() that gives a result that is understood by deserialize(), yielding one of the built-in icon types.

Implements

IconExt

Implementations

impl Icon

pub const NONE: Option<&'static Icon> = None

pub fn deserialize(value: &Variant) -> Option<Icon>

Deserializes a Icon previously serialized using IconExt::serialize().

value

a glib::Variant created with IconExt::serialize()

Returns

a Icon, or None when deserialization fails.

pub fn for_string(str: &str) -> Result<Icon, Error>

Generate a Icon instance from str. This function can fail if str is not valid - see IconExt::to_string() for discussion.

If your application or library provides one or more Icon implementations you need to ensure that each GType is registered with the type system prior to calling for_string().

str

A string obtained via IconExt::to_string().

Returns

An object implementing the Icon interface or None if error is set.

Trait Implementations

impl Clone for Icon

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 Icon

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

Formats the value using the given formatter.

impl Display for Icon

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

Formats the value using the given formatter.

impl HasParamSpec for Icon

type ParamSpec = ParamSpecObject

type SetValue = Icon

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Icon

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 Icon

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

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 Icon

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 Icon

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Icon

impl IsA<Icon> for BytesIcon

impl IsA<Icon> for Emblem

impl IsA<Icon> for EmblemedIcon

impl IsA<Icon> for FileIcon

impl IsA<Icon> for LoadableIcon

impl IsA<Icon> for ThemedIcon