Struct gtk::IconTheme

source · [−]

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

Expand description

IconTheme provides a facility for looking up icons by name and size. The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification There is a fallback icon theme, named hicolor, where applications should install their icons, but additional icon themes can be installed as operating system vendors and users choose.

Named icons are similar to the deprecated [Stock Items][gtkstock], and the distinction between the two may be a bit confusing. A few things to keep in mind:

Stock images usually are used in conjunction with [Stock Items][gtkstock], such as GTK_STOCK_OK or GTK_STOCK_OPEN. Named icons are easier to set up and therefore are more useful for new icons that an application wants to add, such as application icons or window icons.
Stock images can only be loaded at the symbolic sizes defined by the IconSize enumeration, or by custom sizes defined by gtk_icon_size_register(), while named icons are more flexible and any pixel size can be specified.
Because stock images are closely tied to stock items, and thus to actions in the user interface, stock images may come in multiple variants for different widget states or writing directions.

A good rule of thumb is that if there is a stock image for what you want to use, use it, otherwise use a named icon. It turns out that internally stock images are generally defined in terms of one or more named icons. (An example of the more than one case is icons that depend on writing direction; GTK_STOCK_GO_FORWARD uses the two themed icons “gtk-stock-go-forward-ltr” and “gtk-stock-go-forward-rtl”.)

In many cases, named themes are used indirectly, via Image or stock items, rather than directly, but looking up icons directly is also simple. The IconTheme object acts as a database of all the icons in the current theme. You can create new IconTheme objects, but it’s much more efficient to use the standard icon theme for the gdk::Screen so that the icon information is shared with other people looking up icons.

⚠️ The following code is in C ⚠️

GError *error = NULL;
GtkIconTheme *icon_theme;
GdkPixbuf *pixbuf;

icon_theme = gtk_icon_theme_get_default ();
pixbuf = gtk_icon_theme_load_icon (icon_theme,
                                   "my-icon-name", // icon name
                                   48, // icon size
                                   0,  // flags
                                   &error);
if (!pixbuf)
  {
    g_warning ("Couldn’t load icon: %s", error->message);
    g_error_free (error);
  }
else
  {
    // Use the pixbuf
    g_object_unref (pixbuf);
  }

Struct gtk::IconTheme

Implementations

impl IconTheme

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

pub fn new() -> IconTheme

pub fn default() -> Option<IconTheme>

pub fn for_screen(screen: &Screen) -> Option<IconTheme>

Trait Implementations

impl Clone for IconTheme

fn clone(&self) -> Self

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

impl Debug for IconTheme

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

impl Default for IconTheme

fn default() -> Self

impl Display for IconTheme

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

impl Hash for IconTheme

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

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

impl Ord for IconTheme

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

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

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

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

impl ParentClassIs for IconTheme

type Parent = Object

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

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

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

impl<OT: ObjectType> PartialOrd<OT> for IconTheme

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

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

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

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

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

impl StaticType for IconTheme

fn static_type() -> Type

impl Eq for IconTheme

Auto Trait Implementations

impl RefUnwindSafe for IconTheme

impl !Send for IconTheme

impl !Sync for IconTheme

impl Unpin for IconTheme

impl UnwindSafe for IconTheme

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for T where T: ObjectType,

fn upcast<T>(self) -> T where T: ObjectType, Self: IsA<T>,

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

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

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

fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<U> IsSubclassableExt for U where U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>) where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for T where T: ObjectType,

fn is<U>(&self) -> bool where U: StaticType,

fn type_(&self) -> Type

fn object_class(&self) -> &Class<Object>

fn class(&self) -> &Class<T> where T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>> where U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where U: IsInterface,

fn try_set_property<V>( &self, property_name: &str, value: V) -> Result<(), BoolError> where V: ToValue,

fn set_property<V>(&self, property_name: &str, value: V) where V: ToValue,

fn try_set_property_from_value( &self, property_name: &str, value: &Value) -> Result<(), BoolError>

fn set_property_from_value(&self, property_name: &str, value: &Value)

fn try_set_properties( &self, property_values: &[(&str, &dyn ToValue)]) -> Result<(), BoolError>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Cast for T where
T: ObjectType,

fn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,

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

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

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

fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,

impl<T, U> Into<U> for T where
U: From<T>,

impl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for T where
T: ObjectType,

fn is<U>(&self) -> bool where
U: StaticType,

fn class(&self) -> &Class<T> where
T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,

fn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,

fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

fn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>

fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

fn set_properties(&self, property_values: &[(&str, &dyn ToValue )])

fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

fn set_properties_from_value(&self, property_values: &[(&str, Value )])

fn try_property<V>(&self, property_name: &str) -> Result<V, BoolError> where
V: 'static + for<'b> FromValue<'b>,

fn property<V>(&self, property_name: &str) -> V where
V: 'static + for<'b> FromValue<'b>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,

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

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

fn try_connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

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

fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + Fn(&[Value ]) -> Option<Value>,

fn try_connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: 'static + Fn(&[Value ]) -> Option<Value>,

fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: 'static + Fn(&[Value ]) -> Option<Value>,

unsafe fn try_connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value ]) -> Option<Value>,

unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerId where
F: Fn(&[Value ]) -> Option<Value>,

unsafe fn try_connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value ]) -> Option<Value>,

fn try_connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn try_connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId

unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerId where
F: Fn(&[Value ]) -> Option<Value>,

fn try_emit<R>(
&self,
signal_id: SignalId,
args: &[&dyn ToValue ]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue ]) -> R where
R: TryFromClosureReturnValue,

fn try_emit_with_values(
&self,
signal_id: SignalId,
args: &[Value ]
) -> Result<Option<Value>, BoolError>

fn emit_with_values(&self, signal_id: SignalId, args: &[Value ]) -> Option<Value>

fn try_emit_by_name<R>(
&self,
signal_name: &str,
args: &[&dyn ToValue ]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue ]) -> R where
R: TryFromClosureReturnValue,

fn try_emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value ]
) -> Result<Option<Value>, BoolError>

fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value ]
) -> Option<Value>

fn try_emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue ]
) -> Result<R, BoolError> where
R: TryFromClosureReturnValue,

fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue ]
) -> R where
R: TryFromClosureReturnValue,

fn try_emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value ]
) -> Result<Option<Value>, BoolError>

fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value ]
) -> Option<Value>

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

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),

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