Package org.gnome.adw

Class PreferencesRow

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.gtk.ListBoxRow

org.gnome.adw.PreferencesRow

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

Direct Known Subclasses:

ActionRow, ButtonRow, EntryRow, ExpanderRow

@Generated("io.github.jwharm.JavaGI")
public class PreferencesRow
extends ListBoxRow
implements Accessible, Actionable, Buildable, ConstraintTarget

A ListBoxRow used to present preferences.

The AdwPreferencesRow widget has a title that PreferencesDialog will use to let the user look for a preference. It doesn't present the title in any way and lets you present the preference as you please.

ActionRow and its derivatives are convenient to use as preference rows as they take care of presenting the preference's title while letting you compose the inputs of the preference around it.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.ListBoxRow

ListBoxRow.ActivateCallback, ListBoxRow.ListBoxRowClass

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.Widget$Impl, Widget.WidgetClass

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.Accessible$Impl, Accessible.AccessibleInterface

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

Actionable.Actionable$Impl, Actionable.ActionableInterface

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

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected PreferencesRow	asParent()	Returns this instance as if it were its parent type.
static PreferencesRow.Builder<? extends PreferencesRow.Builder>	builder()	A PreferencesRow.Builder object constructs a PreferencesRow with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getTitle()	Gets the title of the preference represented by self.
boolean	getTitleSelectable()	Gets whether the user can copy the title from the label
static @Nullable Type	getType()	Get the GType of the PreferencesRow class
boolean	getUseMarkup()	Gets whether to use Pango markup for the title label.
boolean	getUseUnderline()	Gets whether an embedded underline in the title indicates a mnemonic.
void	setTitle(String title)	Sets the title of the preference represented by self.
void	setTitleSelectable(boolean titleSelectable)	Sets whether the user can copy the title from the label
void	setUseMarkup(boolean useMarkup)	Sets whether to use Pango markup for the title label.
void	setUseUnderline(boolean useUnderline)	Sets whether an embedded underline in the title indicates a mnemonic.

Methods inherited from class org.gnome.gtk.ListBoxRow

activate, changed, emitActivate, getActivatable, getChild, getHeader, getIndex, getSelectable, isSelected, onActivate, setActivatable, setChild, setHeader, setSelectable

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, 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 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.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, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Actionable

getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionName

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

PreferencesRow

public PreferencesRow(MemorySegment address)

Create a PreferencesRow proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PreferencesRow

public PreferencesRow()

Creates a new PreferencesRow.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the PreferencesRow class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PreferencesRow 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 ListBoxRow

getTitle

public String getTitle()

Gets the title of the preference represented by self.

Returns:

the title

getTitleSelectable

public boolean getTitleSelectable()

Gets whether the user can copy the title from the label

Returns:

whether the user can copy the title from the label

Since:

1.1

getUseMarkup

public boolean getUseMarkup()

Gets whether to use Pango markup for the title label.

Returns:

whether to use markup

Since:

1.2

getUseUnderline

public boolean getUseUnderline()

Gets whether an embedded underline in the title indicates a mnemonic.

Returns:

whether an embedded underline in the title indicates a mnemonic

setTitle

public void setTitle(String title)

Sets the title of the preference represented by self.

The title is interpreted as Pango markup unless PreferencesRow:use-markup is set to FALSE.

Parameters:

title - the title

setTitleSelectable

public void setTitleSelectable(boolean titleSelectable)

Sets whether the user can copy the title from the label

See also Gtk.Label:selectable.

Parameters:

titleSelectable - TRUE if the user can copy the title from the label

Since:

1.1

setUseMarkup

public void setUseMarkup(boolean useMarkup)

Sets whether to use Pango markup for the title label.

Subclasses may also use it for other labels, such as subtitle.

See also Pango.parseMarkup(java.lang.String, int, int, org.javagi.base.Out<org.gnome.pango.AttrList>, org.javagi.base.Out<java.lang.String>, org.javagi.base.Out<java.lang.Integer>).

Parameters:

useMarkup - whether to use markup

Since:

1.2

setUseUnderline

public void setUseUnderline(boolean useUnderline)

Sets whether an embedded underline in the title indicates a mnemonic.

Parameters:

useUnderline - TRUE if underlines in the text indicate mnemonics

builder

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

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

Returns:

the builder object