Package org.gnome.adw

Class PreferencesDialog

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

org.gnome.adw.PreferencesDialog

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, ShortcutManager, Proxy

@Generated("io.github.jwharm.JavaGI")
public class PreferencesDialog
extends Dialog
implements Accessible, Buildable, ConstraintTarget, ShortcutManager

A dialog showing application's preferences.

The AdwPreferencesDialog widget presents an application's preferences gathered into pages and groups. The preferences are searchable by the user.

Actions
AdwPrefencesDialog defines the navigation.pop action, it doesn't take any parameters and pops the current subpage from the navigation stack, equivalent to calling popSubpage().

CSS nodes
AdwPreferencesDialog has a main CSS node with the name dialog and the style class .preferences.

Since:

1.5

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.adw.Dialog

Dialog.CloseAttemptCallback, Dialog.ClosedCallback, Dialog.DialogClass

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

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

ShortcutManager.ShortcutManager$Impl, ShortcutManager.ShortcutManagerInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	add(PreferencesPage page)	Adds a preferences page to self.
void	addToast(Toast toast)	Displays toast.
protected PreferencesDialog	asParent()	Returns this instance as if it were its parent type.
static PreferencesDialog.Builder<? extends PreferencesDialog.Builder>	builder()	A PreferencesDialog.Builder object constructs a PreferencesDialog with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getSearchEnabled()	Gets whether search is enabled for self.
static @Nullable Type	getType()	Get the GType of the PreferencesDialog class
@Nullable PreferencesPage	getVisiblePage()	Gets the currently visible page of self.
@Nullable String	getVisiblePageName()	Gets the name of currently visible page of self.
boolean	popSubpage()	Pop the visible page from the subpage stack of self.
void	pushSubpage(NavigationPage page)	Pushes page onto the subpage stack of self.
void	remove(PreferencesPage page)	Removes a page from self.
void	setSearchEnabled(boolean searchEnabled)	Sets whether search is enabled for self.
void	setVisiblePage(PreferencesPage page)	Makes page the visible page of self.
void	setVisiblePageName(String name)	Makes the page with the given name visible.

Methods inherited from class org.gnome.adw.Dialog

addBreakpoint, close, closeAttempt, closed, emitCloseAttempt, emitClosed, forceClose, getCanClose, getChild, getContentHeight, getContentWidth, getCurrentBreakpoint, getDefaultWidget, getFocus, getFollowsContentSize, getPresentationMode, getTitle, onCloseAttempt, onClosed, present, setCanClose, setChild, setContentHeight, setContentWidth, setDefaultWidget, setFocus, setFollowsContentSize, setPresentationMode, setTitle

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

PreferencesDialog

public PreferencesDialog(MemorySegment address)

Create a PreferencesDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PreferencesDialog

public PreferencesDialog()

Creates a new PreferencesDialog.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the PreferencesDialog class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected PreferencesDialog 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 Dialog

add

public void add(PreferencesPage page)

Adds a preferences page to self.

Parameters:

page - the page to add

Since:

1.5

addToast

public void addToast(Toast toast)

Displays toast.

See ToastOverlay.addToast(org.gnome.adw.Toast).

Parameters:

toast - a toast

Since:

1.5

getSearchEnabled

public boolean getSearchEnabled()

Gets whether search is enabled for self.

Returns:

whether search is enabled for self.

Since:

1.5

getVisiblePage

public @Nullable PreferencesPage getVisiblePage()

Gets the currently visible page of self.

Returns:

the visible page

Since:

1.5

getVisiblePageName

public @Nullable String getVisiblePageName()

Gets the name of currently visible page of self.

Returns:

the name of the visible page

Since:

1.5

popSubpage

public boolean popSubpage()

Pop the visible page from the subpage stack of self.

Returns:

TRUE if a page has been popped

Since:

1.5

pushSubpage

public void pushSubpage(NavigationPage page)

Pushes page onto the subpage stack of self.

The page will be automatically removed when popped.

Parameters:

page - the subpage

Since:

1.5

remove

public void remove(PreferencesPage page)

Removes a page from self.

Parameters:

page - the page to remove

Since:

1.5

setSearchEnabled

public void setSearchEnabled(boolean searchEnabled)

Sets whether search is enabled for self.

Parameters:

searchEnabled - whether search is enabled

Since:

1.5

setVisiblePage

public void setVisiblePage(PreferencesPage page)

Makes page the visible page of self.

Parameters:

page - a page of this PreferencesDialog

Since:

1.5

setVisiblePageName

public void setVisiblePageName(String name)

Makes the page with the given name visible.

See PreferencesDialog:visible-page.

Parameters:

name - the name of the page to make visible

Since:

1.5

builder

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

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

Returns:

the builder object