Struct gtk4::IconPaintable

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

Contains information found when looking up an icon in IconTheme.

IconPaintable implements gdk::Paintable.

Properties

file

The file representing the icon, if any.

Readable | Writeable | Construct Only

icon-name

The icon name that was chosen during lookup.

Readable | Writeable | Construct Only

is-symbolic

Whether the icon is symbolic or not.

Readable | Writeable | Construct Only

Implements

glib::ObjectExt, gdk::prelude::PaintableExt, SymbolicPaintableExt

Implementations

impl IconPaintable

pub fn for_file(file: &impl IsA<File>, size: i32, scale: i32) -> IconPaintable

Creates a IconPaintable for a file with a given size and scale.

The icon can then be rendered by using it as a gdk::Paintable.

file

a GFile

size

desired icon size

scale

the desired scale

Returns

a IconPaintable containing for the icon. Unref with g_object_unref()

pub fn file(&self) -> Option<File>

Gets the GFile that was used to load the icon.

Returns None if the icon was not loaded from a file.

Returns

the GFile for the icon

pub fn icon_name(&self) -> Option<PathBuf>

Get the icon name being used for this icon.

When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to gtk_icon_theme_lookup_icon() or the always-available “image-missing”. The icon chosen is returned by this function.

If the icon was created without an icon theme, this function returns None.

Returns

the themed icon-name for the icon, or None if its not a themed icon.

pub fn is_symbolic(&self) -> bool

Checks if the icon is symbolic or not.

This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future.

Note that to render a symbolic IconPaintable properly (with recoloring), you have to set its icon name on a Image.

Returns

true if the icon is symbolic, false otherwise

Trait Implementations

impl Clone for IconPaintable

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 IconPaintable

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

Formats the value using the given formatter.

impl Display for IconPaintable

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

Formats the value using the given formatter.

impl HasParamSpec for IconPaintable

type ParamSpec = ParamSpecObject

type SetValue = IconPaintable

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IconPaintable

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 IconPaintable

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 IconPaintable

type Parent = Object

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

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 IconPaintable

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 IconPaintable

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IconPaintable

impl IsA<Paintable> for IconPaintable

impl IsA<SymbolicPaintable> for IconPaintable