Class Settings.Builder<B extends Settings.Builder<B>>
- Type Parameters:
B
- the type of the Builder that is returned
- All Implemented Interfaces:
BuilderInterface
- Enclosing class:
Settings
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finish building theSettings
object.setGtkAlternativeButtonOrder
(boolean gtkAlternativeButtonOrder) Whether buttons in dialogs should use the alternative button order.setGtkAlternativeSortArrows
(boolean gtkAlternativeSortArrows) Controls the direction of the sort indicators in sorted list and tree views.setGtkApplicationPreferDarkTheme
(boolean gtkApplicationPreferDarkTheme) Whether the application prefers to use a dark theme.setGtkCursorAspectRatio
(double gtkCursorAspectRatio) The aspect ratio of the text caret.setGtkCursorBlink
(boolean gtkCursorBlink) Whether the cursor should blink.setGtkCursorBlinkTime
(int gtkCursorBlinkTime) Length of the cursor blink cycle, in milliseconds.setGtkCursorBlinkTimeout
(int gtkCursorBlinkTimeout) Time after which the cursor stops blinking, in seconds.setGtkCursorThemeName
(String gtkCursorThemeName) Name of the cursor theme to use.setGtkCursorThemeSize
(int gtkCursorThemeSize) The size to use for cursors.setGtkDecorationLayout
(String gtkDecorationLayout) Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed on the left or right.setGtkDialogsUseHeader
(boolean gtkDialogsUseHeader) Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom.setGtkDndDragThreshold
(int gtkDndDragThreshold) The number of pixels the cursor can move before dragging.setGtkDoubleClickDistance
(int gtkDoubleClickDistance) The maximum distance allowed between two clicks for them to be considered a double click, in pixels.setGtkDoubleClickTime
(int gtkDoubleClickTime) The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.setGtkEnableAccels
(boolean gtkEnableAccels) Whether menu items should have visible accelerators which can be activated.setGtkEnableAnimations
(boolean gtkEnableAnimations) Whether to enable toolkit-wide animations.setGtkEnableEventSounds
(boolean gtkEnableEventSounds) Whether to play any event sounds at all.setGtkEnableInputFeedbackSounds
(boolean gtkEnableInputFeedbackSounds) Whether to play event sounds as feedback to user input.setGtkEnablePrimaryPaste
(boolean gtkEnablePrimaryPaste) Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location.setGtkEntryPasswordHintTimeout
(int gtkEntryPasswordHintTimeout) How long to show the last input character in hidden entries.setGtkEntrySelectOnFocus
(boolean gtkEntrySelectOnFocus) Whether to select the contents of an entry when it is focused.setGtkErrorBell
(boolean gtkErrorBell) Whentrue
, keyboard navigation and other input-related errors will cause a beep.setGtkFontconfigTimestamp
(int gtkFontconfigTimestamp) Timestamp of the current fontconfig configuration.setGtkFontName
(String gtkFontName) The default font to use.setGtkFontRendering
(FontRendering gtkFontRendering) How GTK font rendering is set up.setGtkHintFontMetrics
(boolean gtkHintFontMetrics) Whether hinting should be applied to font metrics.setGtkIconThemeName
(String gtkIconThemeName) Name of the icon theme to use.setGtkImModule
(String gtkImModule) Which IM (input method) module should be used by default.setGtkKeynavUseCaret
(boolean gtkKeynavUseCaret) Whether GTK should make sure that text can be navigated with a caret, even if it is not editable.setGtkLabelSelectOnFocus
(boolean gtkLabelSelectOnFocus) Whether to select the contents of a selectable label when it is focused.setGtkLongPressTime
(int gtkLongPressTime) The time for a button or touch press to be considered a “long press”.setGtkOverlayScrolling
(boolean gtkOverlayScrolling) Whether scrolled windows may use overlaid scrolling indicators.setGtkPrimaryButtonWarpsSlider
(boolean gtkPrimaryButtonWarpsSlider) If the value of this setting istrue
, clicking the primary button in aGtkRange
trough will move the slider, and hence set the range’s value, to the point that you clicked.setGtkPrintBackends
(String gtkPrintBackends) A comma-separated list of print backends to use in the print dialog.setGtkPrintPreviewCommand
(String gtkPrintPreviewCommand) A command to run for displaying the print preview.setGtkRecentFilesEnabled
(boolean gtkRecentFilesEnabled) Whether GTK should keep track of items inside the recently used resources list.setGtkRecentFilesMaxAge
(int gtkRecentFilesMaxAge) The maximum age, in days, of the items inside the recently used resources list.setGtkShellShowsAppMenu
(boolean gtkShellShowsAppMenu) Set totrue
if the desktop environment is displaying the app menu,false
if the app should display it itself.setGtkShellShowsDesktop
(boolean gtkShellShowsDesktop) Set totrue
if the desktop environment is displaying the desktop folder,false
if not.setGtkShellShowsMenubar
(boolean gtkShellShowsMenubar) Set totrue
if the desktop environment is displaying the menubar,false
if the app should display it itself.setGtkShowStatusShapes
(boolean gtkShowStatusShapes) Whentrue
, widgets like switches include shapes to indicate their on/off state.setGtkSoundThemeName
(String gtkSoundThemeName) The XDG sound theme to use for event sounds.setGtkSplitCursor
(boolean gtkSplitCursor) Whether two cursors should be displayed for mixed left-to-right and right-to-left text.setGtkThemeName
(String gtkThemeName) Name of the theme to load.setGtkTitlebarDoubleClick
(String gtkTitlebarDoubleClick) Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows.setGtkTitlebarMiddleClick
(String gtkTitlebarMiddleClick) Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows.setGtkTitlebarRightClick
(String gtkTitlebarRightClick) Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows.setGtkXftAntialias
(int gtkXftAntialias) Whether to antialias fonts.setGtkXftDpi
(int gtkXftDpi) The font resolution, in 1024 * dots/inch.setGtkXftHinting
(int gtkXftHinting) Whether to enable font hinting.setGtkXftHintstyle
(String gtkXftHintstyle) What degree of font hinting to use.setGtkXftRgba
(String gtkXftRgba) The type of subpixel antialiasing to use.Methods inherited from class org.gnome.gobject.GObject.Builder
onNotify
Methods inherited from class io.github.jwharm.javagi.gobject.Builder
addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues
-
Constructor Details
-
Builder
protected Builder()Default constructor for aBuilder
object.
-
-
Method Details
-
build
Finish building theSettings
object. This will callGObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[])
to create a new GObject instance, which is then cast toSettings
.- Overrides:
build
in classGObject.Builder<B extends Settings.Builder<B>>
- Returns:
- a new instance of
Settings
with the properties that were set in the Builder object.
-
setGtkAlternativeButtonOrder
Whether buttons in dialogs should use the alternative button order.- Parameters:
gtkAlternativeButtonOrder
- the value for thegtk-alternative-button-order
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkAlternativeSortArrows
Controls the direction of the sort indicators in sorted list and tree views.By default an arrow pointing down means the column is sorted in ascending order. When set to
true
, this order will be inverted.- Parameters:
gtkAlternativeSortArrows
- the value for thegtk-alternative-sort-arrows
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkApplicationPreferDarkTheme
Whether the application prefers to use a dark theme.If a GTK theme includes a dark variant, it will be used instead of the configured theme.
Some applications benefit from minimizing the amount of light pollution that interferes with the content. Good candidates for dark themes are photo and video editors that make the actual content get all the attention and minimize the distraction of the chrome.
Dark themes should not be used for documents, where large spaces are white/light and the dark chrome creates too much contrast (web browser, text editor...).
- Parameters:
gtkApplicationPreferDarkTheme
- the value for thegtk-application-prefer-dark-theme
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkCursorAspectRatio
The aspect ratio of the text caret.- Parameters:
gtkCursorAspectRatio
- the value for thegtk-cursor-aspect-ratio
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkCursorBlink
Whether the cursor should blink.Also see the
Gtk.Settings:gtk-cursor-blink-timeout
setting, which allows more flexible control over cursor blinking.- Parameters:
gtkCursorBlink
- the value for thegtk-cursor-blink
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkCursorBlinkTime
Length of the cursor blink cycle, in milliseconds.- Parameters:
gtkCursorBlinkTime
- the value for thegtk-cursor-blink-time
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkCursorBlinkTimeout
Time after which the cursor stops blinking, in seconds.The timer is reset after each user interaction.
Setting this to zero has the same effect as setting
Gtk.Settings:gtk-cursor-blink
tofalse
.- Parameters:
gtkCursorBlinkTimeout
- the value for thegtk-cursor-blink-timeout
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkCursorThemeName
-
setGtkCursorThemeSize
The size to use for cursors.0 means to use the default size.
- Parameters:
gtkCursorThemeSize
- the value for thegtk-cursor-theme-size
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkDecorationLayout
Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed on the left or right.The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu).
For example, "menu:minimize,maximize,close" specifies a menu on the left, and minimize, maximize and close buttons on the right.
Note that buttons will only be shown when they are meaningful. E.g. a menu button only appears when the desktop shell does not show the app menu, and a close button only appears on a window that can be closed.
Also note that the setting can be overridden with the
Gtk.HeaderBar:decoration-layout
property.- Parameters:
gtkDecorationLayout
- the value for thegtk-decoration-layout
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkDialogsUseHeader
Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom.This setting does not affect custom dialogs using
GtkDialog
directly, or message dialogs.- Parameters:
gtkDialogsUseHeader
- the value for thegtk-dialogs-use-header
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkDndDragThreshold
The number of pixels the cursor can move before dragging.- Parameters:
gtkDndDragThreshold
- the value for thegtk-dnd-drag-threshold
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkDoubleClickDistance
The maximum distance allowed between two clicks for them to be considered a double click, in pixels.- Parameters:
gtkDoubleClickDistance
- the value for thegtk-double-click-distance
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkDoubleClickTime
The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.- Parameters:
gtkDoubleClickTime
- the value for thegtk-double-click-time
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEnableAccels
Whether menu items should have visible accelerators which can be activated.- Parameters:
gtkEnableAccels
- the value for thegtk-enable-accels
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEnableAnimations
Whether to enable toolkit-wide animations.- Parameters:
gtkEnableAnimations
- the value for thegtk-enable-animations
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEnableEventSounds
Whether to play any event sounds at all.See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
- Parameters:
gtkEnableEventSounds
- the value for thegtk-enable-event-sounds
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEnableInputFeedbackSounds
Whether to play event sounds as feedback to user input.See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
- Parameters:
gtkEnableInputFeedbackSounds
- the value for thegtk-enable-input-feedback-sounds
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEnablePrimaryPaste
Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location.- Parameters:
gtkEnablePrimaryPaste
- the value for thegtk-enable-primary-paste
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEntryPasswordHintTimeout
How long to show the last input character in hidden entries.This value is in milliseconds. 0 disables showing the last char. 600 is a good value for enabling it.
- Parameters:
gtkEntryPasswordHintTimeout
- the value for thegtk-entry-password-hint-timeout
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkEntrySelectOnFocus
Whether to select the contents of an entry when it is focused.- Parameters:
gtkEntrySelectOnFocus
- the value for thegtk-entry-select-on-focus
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkErrorBell
Whentrue
, keyboard navigation and other input-related errors will cause a beep.Since the error bell is implemented using gdk_surface_beep(), the windowing system may offer ways to configure the error bell in many ways, such as flashing the window or similar visual effects.
- Parameters:
gtkErrorBell
- the value for thegtk-error-bell
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkFontName
-
setGtkFontRendering
How GTK font rendering is set up.When set to
Gtk.FontRendering.MANUAL
, GTK respects the low-level font-related settings (Gtk.Settings:gtk-hint-font-metrics
,Gtk.Settings:gtk-xft-antialias
,Gtk.Settings:gtk-xft-hinting
,Gtk.Settings:gtk-xft-hintstyle
andGtk.Settings:gtk-xft-rgba
) as much as practical.When set to
Gtk.FontRendering.AUTOMATIC
, GTK will consider factors such as screen resolution and scale in deciding how to render fonts.- Parameters:
gtkFontRendering
- the value for thegtk-font-rendering
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkFontconfigTimestamp
Timestamp of the current fontconfig configuration.- Parameters:
gtkFontconfigTimestamp
- the value for thegtk-fontconfig-timestamp
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkHintFontMetrics
Whether hinting should be applied to font metrics.Note that this also turns off subpixel positioning of glyphs, since it conflicts with metrics hinting.
- Parameters:
gtkHintFontMetrics
- the value for thegtk-hint-font-metrics
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkIconThemeName
-
setGtkImModule
Which IM (input method) module should be used by default.This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. This also can be a colon-separated list of input methods, which GTK will try in turn until it finds one available on the system.
See
IMContext
.- Parameters:
gtkImModule
- the value for thegtk-im-module
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkLabelSelectOnFocus
Whether to select the contents of a selectable label when it is focused.- Parameters:
gtkLabelSelectOnFocus
- the value for thegtk-label-select-on-focus
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkLongPressTime
The time for a button or touch press to be considered a “long press”.See
GestureLongPress
.- Parameters:
gtkLongPressTime
- the value for thegtk-long-press-time
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkOverlayScrolling
Whether scrolled windows may use overlaid scrolling indicators.If this is set to
false
, scrolled windows will have permanent scrollbars.- Parameters:
gtkOverlayScrolling
- the value for thegtk-overlay-scrolling
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkPrimaryButtonWarpsSlider
If the value of this setting istrue
, clicking the primary button in aGtkRange
trough will move the slider, and hence set the range’s value, to the point that you clicked.If it is
false
, a primary click will cause the slider/value to move by the range’s page-size towards the point clicked.Whichever action you choose for the primary button, the other action will be available by holding Shift and primary-clicking, or clicking the middle mouse button.
- Parameters:
gtkPrimaryButtonWarpsSlider
- the value for thegtk-primary-button-warps-slider
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkPrintBackends
A comma-separated list of print backends to use in the print dialog.Available print backends depend on the GTK installation, and may include "file", "cups", "lpr" or "papi".
- Parameters:
gtkPrintBackends
- the value for thegtk-print-backends
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkPrintPreviewCommand
A command to run for displaying the print preview.The command should contain a
%f
placeholder, which will get replaced by the path to the pdf file. The command may also contain a%s
placeholder, which will get replaced by the path to a file containing the print settings in the format produced byPrintSettings.toFile(java.lang.String)
.The preview application is responsible for removing the pdf file and the print settings file when it is done.
- Parameters:
gtkPrintPreviewCommand
- the value for thegtk-print-preview-command
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkRecentFilesEnabled
Whether GTK should keep track of items inside the recently used resources list.If set to
false
, the list will always be empty.- Parameters:
gtkRecentFilesEnabled
- the value for thegtk-recent-files-enabled
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkRecentFilesMaxAge
The maximum age, in days, of the items inside the recently used resources list.Items older than this setting will be excised from the list. If set to 0, the list will always be empty; if set to -1, no item will be removed.
- Parameters:
gtkRecentFilesMaxAge
- the value for thegtk-recent-files-max-age
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkShellShowsAppMenu
Set totrue
if the desktop environment is displaying the app menu,false
if the app should display it itself.- Parameters:
gtkShellShowsAppMenu
- the value for thegtk-shell-shows-app-menu
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkShellShowsDesktop
Set totrue
if the desktop environment is displaying the desktop folder,false
if not.- Parameters:
gtkShellShowsDesktop
- the value for thegtk-shell-shows-desktop
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkShellShowsMenubar
Set totrue
if the desktop environment is displaying the menubar,false
if the app should display it itself.- Parameters:
gtkShellShowsMenubar
- the value for thegtk-shell-shows-menubar
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkShowStatusShapes
Whentrue
, widgets like switches include shapes to indicate their on/off state.- Parameters:
gtkShowStatusShapes
- the value for thegtk-show-status-shapes
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkSoundThemeName
The XDG sound theme to use for event sounds.See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
- Parameters:
gtkSoundThemeName
- the value for thegtk-sound-theme-name
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkSplitCursor
Whether two cursors should be displayed for mixed left-to-right and right-to-left text.- Parameters:
gtkSplitCursor
- the value for thegtk-split-cursor
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkThemeName
Name of the theme to load.See
CssProvider
for details about how GTK finds the CSS stylesheet for a theme.- Parameters:
gtkThemeName
- the value for thegtk-theme-name
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkTitlebarDoubleClick
Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows.Recognized actions are minimize, toggle-maximize, menu, lower or none.
- Parameters:
gtkTitlebarDoubleClick
- the value for thegtk-titlebar-double-click
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkTitlebarMiddleClick
Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows.Recognized actions are minimize, toggle-maximize, menu, lower or none.
- Parameters:
gtkTitlebarMiddleClick
- the value for thegtk-titlebar-middle-click
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkTitlebarRightClick
Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows.Recognized actions are minimize, toggle-maximize, menu, lower or none.
- Parameters:
gtkTitlebarRightClick
- the value for thegtk-titlebar-right-click
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkXftAntialias
Whether to antialias fonts.The values are 0 for no, 1 for yes, or -1 for the system default.
- Parameters:
gtkXftAntialias
- the value for thegtk-xft-antialias
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkXftDpi
The font resolution, in 1024 * dots/inch.-1 to use the default value.
- Parameters:
gtkXftDpi
- the value for thegtk-xft-dpi
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkXftHinting
Whether to enable font hinting.The values are 0 for no, 1 for yes, or -1 for the system default.
- Parameters:
gtkXftHinting
- the value for thegtk-xft-hinting
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-
setGtkXftHintstyle
-
setGtkXftRgba
The type of subpixel antialiasing to use.The possible values are none, rgb, bgr, vrgb, vbgr.
Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.
- Parameters:
gtkXftRgba
- the value for thegtk-xft-rgba
property- Returns:
- the
Builder
instance is returned, to allow method chaining
-