Class Avatar

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.Avatar

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

@Generated("org.javagi.JavaGI")
public final class Avatar
extends Widget
implements Accessible, Buildable, ConstraintTarget

A widget displaying an image, with a generated fallback.

AdwAvatar is a widget that shows a round avatar.

AdwAvatar generates an avatar with the initials of the Avatar:text on top of a colored background.

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

If Avatar:show-initials is set to FALSE, Avatar:icon-name or adw-avatar-default-symbolic is shown instead of the initials.

Use Avatar:custom-image to set a custom image.

CSS nodes

AdwAvatar has a single CSS node with name avatar.

Accessibility

AdwAvatar uses the Gtk.AccessibleRole.img role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Avatar.AvatarClass
static class	Avatar.Builder<B extends Avatar.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

Nested classes/interfaces inherited from class InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
Avatar()	Create a new Avatar.
Avatar(int size, @Nullable String text, boolean showInitials)	Creates a new AdwAvatar.
Avatar(MemorySegment address)	Create a Avatar instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Avatar	asParent()	Return this instance as if it were its parent type.
static Avatar.Builder<? extends Avatar.Builder>	builder()	A Avatar.Builder object constructs a Avatar with the specified properties.
Texture	drawToTexture(int scaleFactor)	Renders this Avatar into a Texture at scaleFactor.
@Nullable Paintable	getCustomImage()	Gets the custom image paintable.
@Nullable String	getIconName()	Gets the name of an icon to use as a fallback.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getShowInitials()	Gets whether initials are used instead of an icon on the fallback avatar.
int	getSize()	Gets the size of the avatar.
@Nullable String	getText()	Gets the text used to generate the fallback initials and color.
static @Nullable Type	getType()	Get the GType of the Avatar class.
void	setCustomImage(@Nullable Paintable customImage)	Sets the custom image paintable.
void	setIconName(@Nullable String iconName)	Sets the name of an icon to use as a fallback.
void	setShowInitials(boolean showInitials)	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(@Nullable String text)	Sets the text used to generate the fallback initials and color.

Methods inherited from class Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, 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, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Methods inherited from interface Accessible

announce, getAccessibleId, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface Buildable

getBuildableId

Methods inherited from interface Proxy

handle

Constructor Details

Avatar

public Avatar(MemorySegment address)

Create a Avatar instance for the provided memory address.

Parameters:

address - the memory address of the native object

Avatar

public Avatar(int size,
 @Nullable String text,
 boolean showInitials)

Creates a new AdwAvatar.

Parameters:

size - The size of the avatar

text - the text used to get the initials and color

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

Avatar

public Avatar()

Create a new Avatar.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Avatar class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Avatar asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class Widget

Returns:

the instance as if it were its parent type

drawToTexture

public Texture drawToTexture(int scaleFactor)

Renders this Avatar into a Texture at scaleFactor.

This can be used to export the fallback avatar.

Parameters:

scaleFactor - The scale factor

Returns:

the texture

getCustomImage

public @Nullable Paintable getCustomImage()

Gets the custom image paintable.

Returns:

the custom image

getIconName

public @Nullable String 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 @Nullable String 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 customImage)

Sets the custom image paintable.

Custom image is displayed instead of initials or icon.

Parameters:

customImage - a custom image

setIconName

public void setIconName(@Nullable String iconName)

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

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

Parameters:

iconName - the icon name

setShowInitials

public void setShowInitials(boolean showInitials)

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

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

Parameters:

showInitials - 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 String text)

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

It's only used to generate the color if Avatar:show-initials is FALSE.

Parameters:

text - the text used to get the initials and color

builder

public static Avatar.Builder<? extends Avatar.Builder> builder()

A Avatar.Builder object constructs a Avatar with the specified properties. Use the various set...() methods to set properties, and finish construction with Avatar.Builder.build().

Returns:

the builder object