Package org.gnome.adw

Class ButtonContent

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.ButtonContent

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

@Generated("io.github.jwharm.JavaGI")
public final class ButtonContent
extends Widget
implements Accessible, Buildable, ConstraintTarget

A helper widget for creating buttons.

AdwButtonContent is a box-like widget with an icon and a label.

It's intended to be used as a direct child of Button, MenuButton or SplitButton, when they need to have both an icon and a label, as follows:

<object class="GtkButton">
   <property name="child">
     <object class="AdwButtonContent">
       <property name="icon-name">document-open-symbolic</property>
       <property name="label" translatable="yes">_Open</property>
       <property name="use-underline">True</property>
     </object>
   </property>
 </object>
 

AdwButtonContent handles style classes and connecting the mnemonic to the button automatically.

CSS nodes

 buttoncontent
 ╰── box
     ├── image
     ╰── label
 

AdwButtonContent's CSS node is called buttoncontent. It contains a box subnode that serves as a container for the image and label nodes.

When inside a GtkButton or AdwSplitButton, the button will receive the .image-text-button style class. When inside a GtkMenuButton, the internal GtkButton will receive it instead.

Accessibility
AdwButtonContent uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.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.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
ButtonContent()	Creates a new AdwButtonContent.
ButtonContent(MemorySegment address)	Create a ButtonContent proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ButtonContent	asParent()	Returns this instance as if it were its parent type.
static ButtonContent.Builder<? extends ButtonContent.Builder>	builder()	A ButtonContent.Builder object constructs a ButtonContent with the specified properties.
boolean	getCanShrink()	gets whether the button can be smaller than the natural size of its contents.
String	getIconName()	Gets the name of the displayed icon.
String	getLabel()	Gets the displayed label.
static Type	getType()	Get the GType of the ButtonContent class
boolean	getUseUnderline()	Gets whether an underline in the text indicates a mnemonic.
void	setCanShrink(boolean canShrink)	Sets whether the button can be smaller than the natural size of its contents.
void	setIconName(String iconName)	Sets the name of the displayed icon.
void	setLabel(String label)	Sets the displayed label.
void	setUseUnderline(boolean useUnderline)	Sets whether an underline in the text indicates a mnemonic.

Methods inherited from class org.gnome.gtk.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, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, 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, 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 org.gnome.gobject.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 org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gnome.gtk.Accessible

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

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

ButtonContent

public ButtonContent(MemorySegment address)

Create a ButtonContent proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ButtonContent

public ButtonContent()

Creates a new AdwButtonContent.

Method Details

getType

public static Type getType()

Get the GType of the ButtonContent class

Returns:

the GType

asParent

protected ButtonContent asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Widget

getCanShrink

public boolean getCanShrink()

gets whether the button can be smaller than the natural size of its contents.

Returns:

whether the button can shrink

getIconName

public String getIconName()

Gets the name of the displayed icon.

Returns:

the icon name

getLabel

public String getLabel()

Gets the displayed label.

Returns:

the label

getUseUnderline

public boolean getUseUnderline()

Gets whether an underline in the text indicates a mnemonic.

Returns:

whether an underline in the text indicates a mnemonic

setCanShrink

public void setCanShrink(boolean canShrink)

Sets whether the button can be smaller than the natural size of its contents.

If set to TRUE, the label will ellipsize.

See Button.setCanShrink(boolean).

Parameters:

canShrink - whether the button can shrink

setIconName

public void setIconName(String iconName)

Sets the name of the displayed icon.

If empty, the icon is not shown.

Parameters:

iconName - the new icon name

setLabel

public void setLabel(String label)

Sets the displayed label.

Parameters:

label - the new label

setUseUnderline

public void setUseUnderline(boolean useUnderline)

Sets whether an underline in the text indicates a mnemonic.

The mnemonic can be used to activate the parent button.

See ButtonContent:label.

Parameters:

useUnderline - whether an underline in the text indicates a mnemonic

builder

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

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