Struct libhandy::Avatar

pub struct Avatar { /* private fields */ }

A widget displaying an image, with a generated fallback.

Avatar is a widget to display a round avatar.

A provided image is made round before displaying, if no image is given this widget generates a round fallback with the initials of the text on top of a colored background.

The color is picked based on the hash of the text.

If show-initials is set to FALSE, avatar-default-symbolic is shown instead of the initials.

Use set_loadable_icon() or loadable-icon to set a custom image.

CSS nodes

Avatar has a single CSS node with name avatar.

Properties

icon-name

The name of an icon to use as a fallback.

If no name is set, the avatar-default-symbolic icon will be used. If the name doesn’t match a valid icon, it is an error and no icon will be displayed. If the icon theme is changed, the image will be updated automatically.

Readable | Writeable

loadable-icon

A gio::LoadableIcon used to load the avatar.

Readable | Writeable

show-initials

Whether to show the initials or the fallback icon on the generated avatar.

Readable | Writeable

size

The avatar size of the avatar.

Readable | Writeable

text

Sets the text used to generate the fallback initials and color.

It’s only used to generate the color if show-initials is FALSE.

Readable | Writeable

Widget

app-paintable

Readable | Writeable

can-default

Readable | Writeable

can-focus

Readable | Writeable

composite-child

Readable

double-buffered

Whether the widget is double buffered.

Readable | Writeable

events

Readable | Writeable

expand

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

has-default

Readable | Writeable

has-focus

Readable | Writeable

has-tooltip

Enables or disables the emission of #GtkWidget::query-tooltip on @widget. A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

height-request

Readable | Writeable

hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

hexpand-set

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

is-focus

Readable | Writeable

margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-left

Margin on left side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-right

Margin on right side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

name

Readable | Writeable

no-show-all

Readable | Writeable

opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable

parent

Readable | Writeable

receives-default

Readable | Writeable

scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Readable

sensitive

Readable | Writeable

style

The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space, see #GtkAlign

Readable | Writeable

vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Readable | Writeable

vexpand-set

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Readable | Writeable

visible

Readable | Writeable

width-request

Readable | Writeable

window

The widget’s window if it is realized, None otherwise.

Readable

Implements

[trait@gtk::prelude::DrawingAreaExt], gtk::prelude::WidgetExt, glib::ObjectExt, gtk::prelude::BuildableExt

Implementations

impl Avatar

pub fn new(size: i32, text: Option<&str>, show_initials: bool) -> Avatar

Creates a new Avatar.

size

the size of the avatar

text

the text used to get the initials and color

show_initials

whether to use initials instead of an icon as fallback

Returns

the newly created Avatar

pub fn builder() -> AvatarBuilder

Creates a new builder-pattern struct instance to construct Avatar objects.

This method returns an instance of AvatarBuilder which can be used to create Avatar objects.

pub fn draw_to_pixbuf(&self, size: i32, scale_factor: i32) -> Option<Pixbuf>

Available on crate feature v1_2 only.

Renders @self into a [gdk_pixbuf::Pixbuf][crate::gdk_pixbuf::Pixbuf] at @size and @scale_factor.

This can be used to export the fallback avatar.

size

the size of the pixbuf

scale_factor

the scale factor

Returns

the pixbuf

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

Gets the name of an icon to use as a fallback.

Returns

the icon name

pub fn loadable_icon(&self) -> Option<LoadableIcon>

Available on crate feature v1_2 only.

Gets the gio::LoadableIcon set via set_loadable_icon().

Returns

the gio::LoadableIcon

pub fn shows_initials(&self) -> bool

Gets whether initials are used instead of an icon on the fallback avatar.

Returns

whether initials are used instead of an icon as fallback

pub fn size(&self) -> i32

Gets the size of the avatar.

Returns

the size of the avatar

pub fn text(&self) -> Option<GString>

Gets the text used to generate the fallback initials and color.

Returns

the text used to generate the fallback initials and color

pub fn set_icon_name(&self, icon_name: Option<&str>)

Sets the name of an icon to use as a fallback.

If no name is set, avatar-default-symbolic will be used.

icon_name

the name of the icon from the icon theme

pub fn set_image_load_func( &self, load_image: Option<Box_<dyn Fn(i32) -> Option<Pixbuf> + 'static>> )

👎Deprecated: Since 1.2

A callback which is called when the custom image needs to be reloaded.

It will be called on size or scale-factor changes.

Deprecated since 1.2

use set_loadable_icon() instead.

load_image

callback to set a custom image

pub fn set_loadable_icon(&self, icon: Option<&impl IsA<LoadableIcon>>)

Available on crate feature v1_2 only.

Sets the gio::LoadableIcon to use as an avatar.

The previous avatar is displayed till the new avatar is loaded, to immediately remove the custom avatar set the loadable-icon to NULL.

The gio::LoadableIcon set via this function is preferred over a set `callback::AvatarImageLoadFunc.

icon

a gio::LoadableIcon

pub fn set_show_initials(&self, show_initials: bool)

Sets whether to use initials instead of an icon on the fallback avatar.

show_initials

whether to use initials instead of an icon as fallback

pub fn set_size(&self, size: i32)

Sets the size of the avatar.

size

the size to be used for the avatar

pub fn set_text(&self, text: Option<&str>)

Set the text used to generate the fallback initials color.

text

the text used to get the initials and color

pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_loadable_icon_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v1_2 only.

pub fn connect_show_initials_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_size_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for Avatar

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 Avatar

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

Formats the value using the given formatter.

impl Default for Avatar

fn default() -> Self

Returns the “default value” for a type.

impl Display for Avatar

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

Formats the value using the given formatter.

impl HasParamSpec for Avatar

type ParamSpec = ParamSpecObject

type SetValue = Avatar

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Avatar

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 Avatar

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 ParentClassIs for Avatar

type Parent = DrawingArea

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

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 Avatar

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 Avatar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Avatar

impl IsA<Buildable> for Avatar

impl IsA<DrawingArea> for Avatar

impl IsA<Widget> for Avatar