Package org.gnome.adw

Class PreferencesPage

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

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

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

A page from PreferencesDialog.

The AdwPreferencesPage widget gathers preferences groups into a single page of a preferences window.

CSS nodes
AdwPreferencesPage has a single CSS node with name preferencespage.

Accessibility
AdwPreferencesPage uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
void	add(PreferencesGroup group)	Adds a preferences group to self.
protected PreferencesPage	asParent()	Returns this instance as if it were its parent type.
static PreferencesPage.Builder<? extends PreferencesPage.Builder>	builder()	A PreferencesPage.Builder object constructs a PreferencesPage with the specified properties.
@Nullable Banner	getBanner()	Gets the banner displayed at the top of the page.
String	getDescription()	Gets the description of self.
boolean	getDescriptionCentered()	Gets whether the description is centered.
@Nullable PreferencesGroup	getGroup(int index)	Gets the group at index.
@Nullable String	getIconName()	Gets the icon name for self.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable String	getName()	Gets the name of self.
String	getTitle()	Gets the title of self.
static @Nullable Type	getType()	Get the GType of the PreferencesPage class
boolean	getUseUnderline()	Gets whether an embedded underline in the title indicates a mnemonic.
void	insert(PreferencesGroup group, int index)	Inserts a preferences group to this PreferencesPage at index.
void	remove(PreferencesGroup group)	Removes a group from self.
void	scrollToTop()	Scrolls the scrolled window of this PreferencesPage to the top.
void	setBanner(@Nullable Banner banner)	Sets the banner displayed at the top of the page.
void	setDescription(String description)	Sets the description of self.
void	setDescriptionCentered(boolean centered)	Sets whether the description should be centered.
void	setIconName(@Nullable String iconName)	Sets the icon name for self.
void	setName(@Nullable String name)	Sets the name of self.
void	setTitle(String title)	Sets the title of self.
void	setUseUnderline(boolean useUnderline)	Sets whether an embedded underline in the title 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, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, 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, 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

PreferencesPage

public PreferencesPage(MemorySegment address)

Create a PreferencesPage proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PreferencesPage

public PreferencesPage()

Creates a new PreferencesPage.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the PreferencesPage class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PreferencesPage 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(PreferencesGroup group)

Adds a preferences group to self.

Parameters:

group - the group to add

getBanner

public @Nullable Banner getBanner()

Gets the banner displayed at the top of the page.

Returns:

the banner for this PreferencesPage

Since:

1.7

getDescription

public String getDescription()

Gets the description of self.

Returns:

the description of self.

Since:

1.4

getDescriptionCentered

public boolean getDescriptionCentered()

Gets whether the description is centered.

Returns:

whether the description is centered.

Since:

1.6

getGroup

public @Nullable PreferencesGroup getGroup(int index)

Gets the group at index.

Can return NULL if index is larger than the number of groups in the page.

Parameters:

index - a group index

Returns:

the group at index

Since:

1.8

getIconName

public @Nullable String getIconName()

Gets the icon name for self.

Returns:

the icon name for this PreferencesPage

getName

public @Nullable String getName()

Gets the name of self.

Overrides:

getName in class Widget

Returns:

the name of this PreferencesPage

getTitle

public String getTitle()

Gets the title of self.

Returns:

the title of self.

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

insert

public void insert(PreferencesGroup group,
 int index)

Inserts a preferences group to this PreferencesPage at index.

If index is negative or larger than the number of groups, appends the group, same as add(org.gnome.adw.PreferencesGroup).

Parameters:

group - the group to add

index - the index to insert group a

Since:

1.8

remove

public void remove(PreferencesGroup group)

Removes a group from self.

Parameters:

group - the group to remove

scrollToTop

public void scrollToTop()

Scrolls the scrolled window of this PreferencesPage to the top.

Since:

1.3

setBanner

public void setBanner(@Nullable Banner banner)

Sets the banner displayed at the top of the page.

Parameters:

banner - the banner to display at the top of the page

Since:

1.7

setDescription

public void setDescription(String description)

Sets the description of self.

The description is displayed at the top of the page.

Parameters:

description - the description

Since:

1.4

setDescriptionCentered

public void setDescriptionCentered(boolean centered)

Sets whether the description should be centered.

Parameters:

centered - If the description should be centered

Since:

1.6

setIconName

public void setIconName(@Nullable String iconName)

Sets the icon name for self.

Parameters:

iconName - the icon name

setName

public void setName(@Nullable String name)

Sets the name of self.

Overrides:

setName in class Widget

Parameters:

name - the name

setTitle

public void setTitle(String title)

Sets the title of self.

Parameters:

title - the title

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 PreferencesPage.Builder<? extends PreferencesPage.Builder> builder()

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

Returns:

the builder object