Package ch.bailu.gtk.adw

Class Avatar

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gobject.InitiallyUnowned

ch.bailu.gtk.gtk.Widget

ch.bailu.gtk.adw.Avatar

All Implemented Interfaces:

PointerInterface

public class Avatar
extends Widget

A widget displaying an image, with a generated fallback.

<picture>
<source srcset="avatar-dark.png" media="(prefers-color-scheme: dark)">
<img src="avatar.png" alt="avatar">
</picture>

`AdwAvatar` is a widget that shows a round avatar.

`AdwAvatar` generates an avatar with the initials of the
[property@Avatar:text] on top of a colored background.

The color is picked based on the hash of the [property@Avatar:text].

If [property@Avatar:show-initials] is set to `FALSE`,
[property@Avatar:icon-name] or `avatar-default-symbolic` is shown instead of
the initials.

Use [property@Avatar:custom-image] to set a custom image.

## CSS nodes

`AdwAvatar` has a single CSS node with name `avatar`.

https://gnome.pages.gitlab.gnome.org/libadwaita/doc/main/class.Avatar.html

Nested Class Summary

Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Widget

Widget.OnDestroy, Widget.OnDestroyNotify, Widget.OnDirectionChanged, Widget.OnHide, Widget.OnKeynavFailed, Widget.OnMap, Widget.OnMnemonicActivate, Widget.OnMoveFocus, Widget.OnQueryTooltip, Widget.OnRealize, Widget.OnShow, Widget.OnStateFlagsChanged, Widget.OnTickCallback, Widget.OnUnmap, Widget.OnUnrealize

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gtk.Widget

SIGNAL_ON_DESTROY, SIGNAL_ON_DIRECTION_CHANGED, SIGNAL_ON_HIDE, SIGNAL_ON_KEYNAV_FAILED, SIGNAL_ON_MAP, SIGNAL_ON_MNEMONIC_ACTIVATE, SIGNAL_ON_MOVE_FOCUS, SIGNAL_ON_QUERY_TOOLTIP, SIGNAL_ON_REALIZE, SIGNAL_ON_SHOW, SIGNAL_ON_STATE_FLAGS_CHANGED, SIGNAL_ON_UNMAP, SIGNAL_ON_UNREALIZE

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
Avatar(int size, Str text, boolean show_initials)	Creates a new `AdwAvatar`.
Avatar(int size, String text, boolean show_initials)	Creates a new `AdwAvatar`.
Avatar(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
Accessible	asAccessible()	Implements interface Accessible.
Buildable	asBuildable()	Implements interface Buildable.
ConstraintTarget	asConstraintTarget()	Implements interface ConstraintTarget.
Texture	drawToTexture(int scale_factor)	Renders @self into a [class@Gdk.Texture] at @scale_factor.
static ClassHandler	getClassHandler()
Paintable	getCustomImage()	Gets the custom image paintable.
Str	getIconName()	Gets the name of an icon to use as a fallback.
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
boolean	getShowInitials()	Gets whether initials are used instead of an icon on the fallback avatar.
int	getSize()	Gets the size of the avatar.
Str	getText()	Gets the text used to generate the fallback initials and color.
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
void	setCustomImage(Paintable custom_image)	Sets the custom image paintable.
void	setIconName(Str icon_name)	Sets the name of an icon to use as a fallback.
void	setIconName(String icon_name)	Sets the name of an icon to use as a fallback.
void	setShowInitials(boolean show_initials)	Sets whether to use initials instead of an icon on the fallback avatar.
void	setSize(int size)	Sets the size of the avatar.
void	setText(Str text)	Sets the text used to generate the fallback initials and color.
void	setText(String text)	Sets the text used to generate the fallback initials and color.

Methods inherited from class ch.bailu.gtk.gtk.Widget

actionSetEnabled, actionSetEnabled, activate, activateAction, activateAction, activateActionVariant, activateActionVariant, activateDefault, addController, addCssClass, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeCssClass, removeMnemonicLabel, removeTickCallback, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipMarkup, setTooltipText, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, snapshotChild, triggerTooltipQuery, unmap, unparent, unrealize, unsetStateFlags

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

Avatar

public Avatar(PointerContainer pointer)

Avatar

public Avatar(int size,
 @Nullable
 Str text,
 boolean show_initials)

Creates a new `AdwAvatar`.

Parameters:

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

Avatar

public Avatar(int size,
 String text,
 boolean show_initials)

Creates a new `AdwAvatar`.

Parameters:

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

Method Details

getClassHandler

public static ClassHandler getClassHandler()

drawToTexture

public Texture drawToTexture(int scale_factor)

Renders @self into a [class@Gdk.Texture] at @scale_factor.

This can be used to export the fallback avatar.

Parameters:

scale_factor - The scale factor

Returns:

the texture

getCustomImage

public Paintable getCustomImage()

Gets the custom image paintable.

Returns:

the custom image

getIconName

public Str getIconName()

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

Returns:

the icon name

getShowInitials

public boolean getShowInitials()

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

Returns:

whether initials are used instead of an icon as fallback

getSize

public int getSize()

Gets the size of the avatar.

Returns:

the size of the avatar

getText

public Str getText()

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

Returns:

the text used to generate the fallback initials and color

setCustomImage

public void setCustomImage(@Nullable
 Paintable custom_image)

Sets the custom image paintable.

Custom image is displayed instead of initials or icon.

Parameters:

custom_image - a custom image

setIconName

public void setIconName(@Nullable
 Str icon_name)

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

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

Parameters:

icon_name - the icon name

setIconName

public void setIconName(String icon_name)

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

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

Parameters:

icon_name - the icon name

setShowInitials

public void setShowInitials(boolean show_initials)

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

See [property@Avatar:icon-name] for how to change the fallback icon.

Parameters:

show_initials - whether to use initials instead of an icon as fallback

setSize

public void setSize(int size)

Sets the size of the avatar.

Parameters:

size - The size of the avatar

setText

public void setText(@Nullable
 Str text)

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

It's only used to generate the color if [property@Avatar:show-initials] is
`FALSE`.

Parameters:

text - the text used to get the initials and color

setText

public void setText(String text)

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

It's only used to generate the color if [property@Avatar:show-initials] is
`FALSE`.

Parameters:

text - the text used to get the initials and color

asAccessible

public Accessible asAccessible()

Implements interface Accessible. Call this to get access to interface functions.

Overrides:

asAccessible in class Widget

Returns:

Accessible

asBuildable

public Buildable asBuildable()

Implements interface Buildable. Call this to get access to interface functions.

Overrides:

asBuildable in class Widget

Returns:

Buildable

asConstraintTarget

public ConstraintTarget asConstraintTarget()

Implements interface ConstraintTarget. Call this to get access to interface functions.

Overrides:

asConstraintTarget in class Widget

Returns:

ConstraintTarget

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()