Class Scale
- All Implemented Interfaces:
Proxy
,Accessible
,AccessibleRange
,Buildable
,ConstraintTarget
,Orientable
GtkScale
is a slider control used to select a numeric value.
To use it, you’ll probably want to investigate the methods on its base
class, Range
, in addition to the methods for GtkScale
itself.
To set the value of a scale, you would normally use Range.setValue(double)
.
To detect changes to the value, you would normally use the
Gtk.Range::value-changed
signal.
Note that using the same upper and lower bounds for the GtkScale
(through
the GtkRange
methods) will hide the slider itself. This is useful for
applications that want to show an undeterminate value on the scale, without
changing the layout of the application (such as movie or music players).
GtkScale as GtkBuildable
GtkScale
supports a custom <marks>
element, which can contain multiple
<mark\\>
elements. The “value” and “position” attributes have the same
meaning as addMark(double, org.gnome.gtk.PositionType, java.lang.String)
parameters of the same name. If
the element is not empty, its content is taken as the markup to show at
the mark. It can be translated with the usual ”translatable” and
“context” attributes.
Shortcuts and Gestures
GtkPopoverMenu
supports the following keyboard shortcuts:
- Arrow keys,
+
and-
will increment or decrement by step, or by page when combined withCtrl
. PgUp
andPgDn
will increment or decrement by page.Home
andEnd
will set the minimum or maximum value.
CSS nodes
scale[.fine-tune][.marks-before][.marks-after]
├── [value][.top][.right][.bottom][.left]
├── marks.top
│ ├── mark
│ ┊ ├── [label]
│ ┊ ╰── indicator
┊ ┊
│ ╰── mark
├── marks.bottom
│ ├── mark
│ ┊ ├── indicator
│ ┊ ╰── [label]
┊ ┊
│ ╰── mark
╰── trough
├── [fill]
├── [highlight]
╰── slider
GtkScale
has a main CSS node with name scale and a subnode for its contents,
with subnodes named trough and slider.
The main node gets the style class .fine-tune added when the scale is in 'fine-tuning' mode.
If the scale has an origin (see setHasOrigin(boolean)
), there is
a subnode with name highlight below the trough node that is used for rendering
the highlighted part of the trough.
If the scale is showing a fill level (see Range.setShowFillLevel(boolean)
),
there is a subnode with name fill below the trough node that is used for
rendering the filled in part of the trough.
If marks are present, there is a marks subnode before or after the trough node, below which each mark gets a node with name mark. The marks nodes get either the .top or .bottom style class.
The mark node has a subnode named indicator. If the mark has text, it also has a subnode named label. When the mark is either above or left of the scale, the label subnode is the first when present. Otherwise, the indicator subnode is the first.
The main CSS node gets the 'marks-before' and/or 'marks-after' style classes added depending on what marks are present.
If the scale is displaying the value (see Gtk.Scale:draw-value
),
there is subnode with name value. This node will get the .top or .bottom style
classes similar to the marks node.
Accessibility
GtkScale
uses the AccessibleRole.SLIDER
role.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Scale.Builder<B extends Scale.Builder<B>>
Inner class implementing a builder pattern to construct a GObject with properties.static class
Nested classes/interfaces inherited from class org.gnome.gtk.Range
Range.AdjustBoundsCallback, Range.ChangeValueCallback, Range.MoveSliderCallback, Range.RangeClass, Range.ValueChangedCallback
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.WidgetClass, Widget.WidgetImpl
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.AccessibleImpl, Accessible.AccessibleInterface
Nested classes/interfaces inherited from interface org.gnome.gtk.AccessibleRange
AccessibleRange.AccessibleRangeImpl, AccessibleRange.AccessibleRangeInterface
Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable
Buildable.BuildableIface, Buildable.BuildableImpl
Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget
ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface
Nested classes/interfaces inherited from interface org.gnome.gtk.Orientable
Orientable.OrientableIface, Orientable.OrientableImpl
-
Constructor Summary
ConstructorDescriptionScale
(MemorySegment address) Create a Scale proxy instance for the provided memory address.Scale
(Orientation orientation, @Nullable Adjustment adjustment) Creates a newGtkScale
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addMark
(double value, PositionType position, @Nullable String markup) Adds a mark atvalue
.protected Scale
asParent()
Returns this instance as if it were its parent type.static Scale.Builder
<? extends Scale.Builder> builder()
AScale.Builder
object constructs aScale
with the specified properties.void
Removes any marks that have been added.int
Gets the number of decimal places that are displayed in the value.boolean
Returns whether the current value is displayed as a string next to the slider.boolean
Returns whether the scale has an origin.Gets thePangoLayout
used to display the scale.void
getLayoutOffsets
(@Nullable Out<Integer> x, @Nullable Out<Integer> y) Obtains the coordinates where the scale will draw thePangoLayout
representing the text in the scale.static MemoryLayout
The memory layout of the native struct.static Type
getType()
Get the GType of the Scale classGets the position in which the current value is displayed.void
setDigits
(int digits) Sets the number of decimal places that are displayed in the value.void
setDrawValue
(boolean drawValue) Specifies whether the current value is displayed as a string next to the slider.void
setFormatValueFunc
(@Nullable ScaleFormatValueFunc func) func
allows you to change how the scale value is displayed.void
setHasOrigin
(boolean hasOrigin) Sets whether the scale has an origin.void
setValuePos
(PositionType pos) Sets the position in which the current value is displayed.static Scale
withRange
(Orientation orientation, double min, double max, double step) Creates a new scale widget with a range frommin
tomax
.Methods inherited from class org.gnome.gtk.Range
adjustBounds, changeValue, emitAdjustBounds, emitChangeValue, emitMoveSlider, emitValueChanged, getAdjustment, getFillLevel, getFlippable, getInverted, getRangeBorder, getRangeRect, getRestrictToFillLevel, getRoundDigits, getShowFillLevel, getSliderRange, getSliderSizeFixed, getValue, moveSlider, onAdjustBounds, onChangeValue, onMoveSlider, onValueChanged, setAdjustment, setFillLevel, setFlippable, setIncrements, setInverted, setRange, setRestrictToFillLevel, setRoundDigits, setShowFillLevel, setSliderSizeFixed, setValue, valueChanged
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, 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, 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, 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, getPrivate, readGClass, writeGClass
Methods inherited from class io.github.jwharm.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, updateProperty, updateRelation, updateState
Methods inherited from interface org.gnome.gtk.Buildable
getBuildableId
Methods inherited from interface org.gnome.gtk.Orientable
getOrientation, setOrientation
-
Constructor Details
-
Scale
Create a Scale proxy instance for the provided memory address.- Parameters:
address
- the memory address of the native object
-
Scale
Creates a newGtkScale
.- Parameters:
orientation
- the scale’s orientation.adjustment
- theAdjustment
which sets the range of the scale, ornull
to create a new adjustment.
-
-
Method Details
-
getType
-
getMemoryLayout
The memory layout of the native struct.- Returns:
- the memory layout
-
asParent
Returns this instance as if it were its parent type. This is mostly synonymous to the Javasuper
keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" withsuper.methodName()
doesn't work, because it invokes the overridden function pointer again. To chain up, callasParent().methodName()
. This will call the native function pointer of this virtual method in the typeclass of the parent type. -
withRange
Creates a new scale widget with a range frommin
tomax
.The returns scale will have the given orientation and will let the user input a number between
min
andmax
(includingmin
andmax
) with the incrementstep
.step
must be nonzero; it’s the distance the slider moves when using the arrow keys to adjust the scale value.Note that the way in which the precision is derived works best if
step
is a power of ten. If the resulting precision is not suitable for your needs, usesetDigits(int)
to correct it.- Parameters:
orientation
- the scale’s orientation.min
- minimum valuemax
- maximum valuestep
- step increment (tick size) used with keyboard shortcuts- Returns:
- a new
GtkScale
-
addMark
Adds a mark atvalue
.A mark is indicated visually by drawing a tick mark next to the scale, and GTK makes it easy for the user to position the scale exactly at the marks value.
If
markup
is notnull
, text is shown next to the tick mark.To remove marks from a scale, use
clearMarks()
.- Parameters:
value
- the value at which the mark is placed, must be between the lower and upper limits of the scales’ adjustmentposition
- where to draw the mark. For a horizontal scale,PositionType.TOP
andPositionType.LEFT
are drawn above the scale, anything else below. For a vertical scale,PositionType.LEFT
andPositionType.TOP
are drawn to the left of the scale, anything else to the right.markup
- Text to be shown at the mark, using Pango markup
-
clearMarks
public void clearMarks()Removes any marks that have been added. -
getDigits
public int getDigits()Gets the number of decimal places that are displayed in the value.- Returns:
- the number of decimal places that are displayed
-
getDrawValue
public boolean getDrawValue()Returns whether the current value is displayed as a string next to the slider.- Returns:
- whether the current value is displayed as a string
-
getHasOrigin
public boolean getHasOrigin()Returns whether the scale has an origin.- Returns:
true
if the scale has an origin.
-
getLayout
-
getLayoutOffsets
public void getLayoutOffsets(@Nullable @Nullable Out<Integer> x, @Nullable @Nullable Out<Integer> y) Obtains the coordinates where the scale will draw thePangoLayout
representing the text in the scale.Remember when using the
PangoLayout
function you need to convert to and from pixels usingPANGO_PIXELS()
orPANGO_SCALE
.If the
Gtk.Scale:draw-value
property isfalse
, the return values are undefined.- Parameters:
x
- location to store X offset of layouty
- location to store Y offset of layout
-
getValuePos
Gets the position in which the current value is displayed.- Returns:
- the position in which the current value is displayed
-
setDigits
public void setDigits(int digits) Sets the number of decimal places that are displayed in the value.Also causes the value of the adjustment to be rounded to this number of digits, so the retrieved value matches the displayed one, if
Gtk.Scale:draw-value
istrue
when the value changes. If you want to enforce rounding the value whenGtk.Scale:draw-value
isfalse
, you can setGtk.Range:round-digits
instead.Note that rounding to a small number of digits can interfere with the smooth autoscrolling that is built into
GtkScale
. As an alternative, you can usesetFormatValueFunc(org.gnome.gtk.ScaleFormatValueFunc)
to format the displayed value yourself.- Parameters:
digits
- the number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00, etc
-
setDrawValue
public void setDrawValue(boolean drawValue) Specifies whether the current value is displayed as a string next to the slider.- Parameters:
drawValue
-true
to draw the value
-
setFormatValueFunc
func
allows you to change how the scale value is displayed.The given function will return an allocated string representing
value
. That string will then be used to display the scale's value.If
NULL
is passed asfunc
, the value will be displayed on its own, rounded according to the value of theGtk.Scale:digits
property.- Parameters:
func
- function that formats the value
-
setHasOrigin
public void setHasOrigin(boolean hasOrigin) Sets whether the scale has an origin.If
Gtk.Scale:has-origin
is set totrue
(the default), the scale will highlight the part of the trough between the origin (bottom or left side) and the current value.- Parameters:
hasOrigin
-true
if the scale has an origin
-
setValuePos
Sets the position in which the current value is displayed.- Parameters:
pos
- the position in which the current value is displayed
-
builder
AScale.Builder
object constructs aScale
with the specified properties. Use the variousset...()
methods to set properties, and finish construction withScale.Builder.build()
.
-