[−]Struct gio::Icon

pub struct Icon(_, _);

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 Icon::hash.

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

For serializing a Icon, use Icon::serialize and Icon::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 Icon::serialize that gives a result that is understood by Icon::deserialize, yielding one of the built-in icon types.

Implements

Methods

`impl Icon`[src]

`pub fn deserialize(value: &Variant) -> Option<Icon>`[src]

Deserializes a Icon previously serialized using Icon::serialize.

`value`

a glib::Variant created with Icon::serialize

Returns

a Icon, or None when deserialization fails.

`pub fn hash(&self) -> u32`[src]

Gets a hash for an icon.

`icon`

gconstpointer to an icon object.

Returns

a guint containing a hash for the icon, suitable for use in a glib::HashTable or similar data structure.

`pub fn new_for_string(str: &str) -> Result<Icon, Error>`[src]

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

If your application or library provides one or more Icon implementations you need to ensure that each glib::Type is registered with the type system prior to calling Icon::new_for_string.

`str`

A string obtained via Icon::to_string.

Returns

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

Trait Implementations

`impl Clone for Icon`

`fn clone(&self) -> Icon`

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Icon`

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

`impl Display for Icon`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Eq for Icon`

`impl Hash for Icon`

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

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

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

`impl Ord for Icon`

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

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

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

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

`impl<T: ObjectType> PartialEq<T> for Icon`

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

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

`impl<T: ObjectType> PartialOrd<T> for Icon`

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

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

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

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

`#[must_use] fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl StaticType for Icon`

`fn static_type() -> Type`

Auto Trait Implementations

`impl RefUnwindSafe for Icon`

`impl !Send for Icon`

`impl !Sync for Icon`

`impl Unpin for Icon`

`impl UnwindSafe for Icon`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>,` [src]

`impl<T> Cast for T where T: ObjectType,` [src]

`fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,` [src]

`fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,` [src]

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

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

`fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,` [src]

`fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,` [src]

`unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,` [src]

`unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,` [src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ObjectExt for T where T: ObjectType,` [src]

`fn is<U>(&self) -> bool where U: StaticType,` [src]

`fn get_type(&self) -> Type`[src]

`fn get_object_class(&self) -> &ObjectClass`[src]

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,` [src]

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,` [src]

`fn block_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn stop_signal_emission(&self, signal_name: &str)`[src]

`fn disconnect(&self, handler_id: SignalHandlerId)`[src]

`fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec),` [src]

`unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId where F: Fn(&T, &ParamSpec),` [src]

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,` [src]

`fn notify_by_pspec(&self, pspec: &ParamSpec)`[src]

`fn has_property<'a, N>( &self, property_name: N, type_: Option<Type> ) -> Result<(), BoolError> where N: Into<&'a str>,` [src]

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,` [src]

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,` [src]

`fn list_properties(&self) -> Vec<ParamSpec>`[src]

`fn connect<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, N: Into<&'a str>,` [src]

`fn connect_local<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + 'static, N: Into<&'a str>,` [src]

`unsafe fn connect_unsafe<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value>, N: Into<&'a str>,` [src]

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,` [src]

`fn downgrade(&self) -> WeakRef<T>`[src]

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,` [src]

`fn ref_count(&self) -> u32`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`[src]

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`[src]

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`[src]

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`[src]

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToSendValue for T where T: ToValue + SetValue + Send + ?Sized,` [src]

`fn to_send_value(&self) -> SendValue`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,` [src]

`fn to_value(&self) -> Value`[src]

`fn to_value_type(&self) -> Type`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]