Package org.gnome.adw

Class PreferencesGroup

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.PreferencesGroup

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

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

A group of preference rows.

An AdwPreferencesGroup represents a group or tightly related preferences, which in turn are represented by PreferencesRow.

To summarize the role of the preferences it gathers, a group can have both a title and a description. The title will be used by PreferencesDialog to let the user look for a preference.

The PreferencesGroup:separate-rows property can be used to separate the rows within the group, same as when using the .boxed-list-separate style class instead of .boxed-list.

AdwPreferencesGroup as GtkBuildable
The AdwPreferencesGroup implementation of the Buildable interface supports adding PreferencesRows to the list by omitting "type". If "type" is omitted and the widget isn't a PreferencesRow the child is added to a box below the list.

When the "type" attribute of a child is header-suffix, the child is set as the suffix on the end of the title and description.

CSS nodes
AdwPreferencesGroup has a single CSS node with name preferencesgroup.

Accessibility
AdwPreferencesGroup uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Nested Class Summary

Nested Classes

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

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.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
PreferencesGroup()	Creates a new PreferencesGroup.
PreferencesGroup(MemorySegment address)	Create a PreferencesGroup proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	add(Widget child)	Adds a child to self.
protected PreferencesGroup	asParent()	Returns this instance as if it were its parent type.
void	bindModel(@Nullable ListModel model, @Nullable ListBoxCreateWidgetFunc createRowFunc)	Binds model to self.
static PreferencesGroup.Builder<? extends PreferencesGroup.Builder>	builder()	A PreferencesGroup.Builder object constructs a PreferencesGroup with the specified properties.
@Nullable String	getDescription()	Gets the description of self.
@Nullable Widget	getHeaderSuffix()	Gets the suffix for self's header.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable Widget	getRow(int index)	Gets the row at index.
boolean	getSeparateRows()	Gets whether self's rows are separated.
String	getTitle()	Gets the title of self.
static @Nullable Type	getType()	Get the GType of the PreferencesGroup class
void	remove(Widget child)	Removes a child from self.
void	setDescription(@Nullable String description)	Sets the description for self.
void	setHeaderSuffix(@Nullable Widget suffix)	Sets the suffix for self's header.
void	setSeparateRows(boolean separateRows)	Sets whether self's rows are separated.
void	setTitle(String title)	Sets the title for self.

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.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

PreferencesGroup

public PreferencesGroup(MemorySegment address)

Create a PreferencesGroup proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PreferencesGroup

public PreferencesGroup()

Creates a new PreferencesGroup.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the PreferencesGroup class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PreferencesGroup 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

add

public void add(Widget child)

Adds a child to self.

Parameters:

child - the widget to add

bindModel

public void bindModel(@Nullable ListModel model,
 @Nullable ListBoxCreateWidgetFunc createRowFunc)

Binds model to self.

See ListBox.bindModel(org.gnome.gio.ListModel, org.gnome.gtk.ListBoxCreateWidgetFunc).

Parameters:

model - a list model to bind

createRowFunc - a function creating a row for each item, or NULL in case model is NULL

Since:

1.8

getDescription

public @Nullable String getDescription()

Gets the description of self.

Returns:

the description of this PreferencesGroup

getHeaderSuffix

public @Nullable Widget getHeaderSuffix()

Gets the suffix for self's header.

Returns:

the suffix for self's header.

Since:

1.1

getRow

public @Nullable Widget getRow(int index)

Gets the row at index.

Can return NULL if index is larger than the number of rows in the group.

Parameters:

index - a row index

Returns:

the row at index

Since:

1.8

getSeparateRows

public boolean getSeparateRows()

Gets whether self's rows are separated.

Returns:

whether rows are separated

Since:

1.6

getTitle

public String getTitle()

Gets the title of self.

Returns:

the title of this PreferencesGroup

remove

public void remove(Widget child)

Removes a child from self.

Parameters:

child - the child to remove

setDescription

public void setDescription(@Nullable String description)

Sets the description for self.

Parameters:

description - the description

setHeaderSuffix

public void setHeaderSuffix(@Nullable Widget suffix)

Sets the suffix for self's header.

Displayed above the list, next to the title and description.

Suffixes are commonly used to show a button or a spinner for the whole group.

Parameters:

suffix - the suffix to set

Since:

1.1

setSeparateRows

public void setSeparateRows(boolean separateRows)

Sets whether self's rows are separated.

Equivalent to using the .boxed-list-separate style class on a ListBox instead of .boxed-list.

Parameters:

separateRows - whether to separate rows

Since:

1.6

setTitle

public void setTitle(String title)

Sets the title for self.

Parameters:

title - the title

builder

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

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

Returns:

the builder object