Struct Avatar 

pub struct Avatar { /* private fields */ }

A widget displaying an image, with a generated fallback.

Avatar is a widget that shows a round avatar.

Avatar generates an avatar 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, icon-name or avatar-default-symbolic is shown instead of the initials.

Use custom-image to set a custom image.

CSS nodes

Avatar has a single CSS node with name avatar.

Accessibility

Avatar uses the [enum@Gtk.AccessibleRole.img] role.

Properties

custom-image

A custom image paintable.

Custom image is displayed instead of initials or icon.

Readable | Writeable

icon-name

The name of an icon to use as a fallback.

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

Readable | Writeable

show-initials

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

See icon-name for how to change the fallback icon.

Readable | Writeable

size

The 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

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

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.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the query-tooltip signal on @widget.

A true value indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk::EventController::set_propagation_limit().

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

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 NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and 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 NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

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

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

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

GLib type: GObject with reference counted clone semantics.

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_texture(&self, scale_factor: i32) -> Texture

Renders @self into a gdk::Texture at @scale_factor.

This can be used to export the fallback avatar.

scale_factor

The scale factor

Returns

the texture

pub fn custom_image(&self) -> Option<Paintable>

Gets the custom image paintable.

Returns

the custom image

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

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

Returns

the icon name

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_custom_image(&self, custom_image: Option<&impl IsA<Paintable>>)

Sets the custom image paintable.

Custom image is displayed instead of initials or icon.

custom_image

a custom image

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 icon name

pub fn set_show_initials(&self, show_initials: bool)

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

See icon-name for how to change the fallback icon.

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 of the avatar

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

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

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

text

the text used to get the initials and color

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

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

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

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

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 Avatar

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

type Parent = Widget

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

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 Avatar

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 Avatar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Avatar

impl IsA<Accessible> for Avatar

impl IsA<Buildable> for Avatar

impl IsA<ConstraintTarget> for Avatar

impl IsA<Widget> for Avatar