Struct Icon

pub struct Icon { /* private fields */ }

GIcon 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.

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

To obtain a hash of a GIcon, see Gio::Icon::hash().

To check if two GIcons are equal, see Gio::Icon::equal().

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

If you want to consume GIcon (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 GIcon implementations outside of GIO must implement LoadableIcon.

If your application or library provides one or more GIcon 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

GLib type: GObject with reference counted clone semantics.

Implementations

impl Icon

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

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

Deserializes a #GIcon previously serialized using g_icon_serialize().

value

a #GVariant created with g_icon_serialize()

Returns

a #GIcon, or None when deserialization fails.

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

Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion.

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

str

A string obtained via g_icon_to_string().

Returns

An object implementing the #GIcon interface or None if @error is set.

Trait Implementations

impl Clone for Icon

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 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,

Hashes the memory address of this object.

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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