Interface: ScaleProps

Defined in: react/src/generated/jsx.ts:4633

Props for the Scale widget.

Extends

• RangeProps

Properties

adjustment?

optional adjustment: Adjustment

Defined in: react/src/generated/jsx.ts:4557

The adjustment that is controlled by the range.

Inherited from

RangeProps.adjustment

---

canFocus?

optional canFocus: boolean

Defined in: react/src/generated/jsx.ts:412

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

RangeProps.canFocus

---

canTarget?

optional canTarget: boolean

Defined in: react/src/generated/jsx.ts:414

Whether the widget can receive pointer events.

Inherited from

RangeProps.canTarget

---

children?

optional children: ReactNode

Defined in: react/src/generated/jsx.ts:688

Inherited from

RangeProps.children

---

cssClasses?

optional cssClasses: string[]

Defined in: react/src/generated/jsx.ts:416

A list of css classes applied to this widget.

Inherited from

RangeProps.cssClasses

---

cssName?

optional cssName: string

Defined in: react/src/generated/jsx.ts:423

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

RangeProps.cssName

---

cursor?

optional cursor: number

Defined in: react/src/generated/jsx.ts:425

The cursor used by @widget.

Inherited from

RangeProps.cursor

---

digits?

optional digits: number

Defined in: react/src/generated/jsx.ts:4635

The number of decimal places that are displayed in the value.

---

drawValue?

optional drawValue: boolean

Defined in: react/src/generated/jsx.ts:4637

Whether the current value is displayed as a string next to the slider.

---

fillLevel?

optional fillLevel: number

Defined in: react/src/generated/jsx.ts:4559

The fill level (e.g. prebuffering of a network stream).

Inherited from

RangeProps.fillLevel

---

focusable?

optional focusable: boolean

Defined in: react/src/generated/jsx.ts:433

Whether this widget itself will accept the input focus.

Inherited from

RangeProps.focusable

---

focusOnClick?

optional focusOnClick: boolean

Defined in: react/src/generated/jsx.ts:431

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Inherited from

RangeProps.focusOnClick

---

halign?

optional halign: Align

Defined in: react/src/generated/jsx.ts:435

How to distribute horizontal space if widget gets extra space.

Inherited from

RangeProps.halign

---

hasDefault?

optional hasDefault: boolean

Defined in: react/src/generated/jsx.ts:437

Whether the widget is the default widget.

Inherited from

RangeProps.hasDefault

---

hasFocus?

optional hasFocus: boolean

Defined in: react/src/generated/jsx.ts:439

Whether the widget has the input focus.

Inherited from

RangeProps.hasFocus

---

hasOrigin?

optional hasOrigin: boolean

Defined in: react/src/generated/jsx.ts:4639

Whether the scale has an origin.

---

hasTooltip?

optional hasTooltip: boolean

Defined in: react/src/generated/jsx.ts:448

Enables or disables the emission of the [signal@Gtk.Widget::query-tooltip] signal on @widget.

A true value indicates that widget can have a tooltip, in this case the widget will be queried using [signal@Gtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

Inherited from

RangeProps.hasTooltip

---

heightRequest?

optional heightRequest: number

Defined in: react/src/generated/jsx.ts:454

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Inherited from

RangeProps.heightRequest

---

hexpand?

optional hexpand: boolean

Defined in: react/src/generated/jsx.ts:456

Whether to expand horizontally.

Inherited from

RangeProps.hexpand

---

hexpandSet?

optional hexpandSet: boolean

Defined in: react/src/generated/jsx.ts:458

Whether to use the hexpand property.

Inherited from

RangeProps.hexpandSet

---

inverted?

optional inverted: boolean

Defined in: react/src/generated/jsx.ts:4561

If %TRUE, the direction in which the slider moves is inverted.

Inherited from

RangeProps.inverted

---

layoutManager?

optional layoutManager: LayoutManager

Defined in: react/src/generated/jsx.ts:466

The [class@Gtk.LayoutManager] instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

RangeProps.layoutManager

---

limitEvents?

optional limitEvents: boolean

Defined in: react/src/generated/jsx.ts:475

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See [method@Gtk.EventController.set_propagation_limit].

Inherited from

RangeProps.limitEvents

---

marginBottom?

optional marginBottom: number

Defined in: react/src/generated/jsx.ts:483

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

RangeProps.marginBottom

---

marginEnd?

optional marginEnd: number

Defined in: react/src/generated/jsx.ts:494

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

RangeProps.marginEnd

---

marginStart?

optional marginStart: number

Defined in: react/src/generated/jsx.ts:505

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

RangeProps.marginStart

---

marginTop?

optional marginTop: number

Defined in: react/src/generated/jsx.ts:513

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

RangeProps.marginTop

---

name?

optional name: string

Defined in: react/src/generated/jsx.ts:515

The name of the widget.

Inherited from

RangeProps.name

---

onAdjustBounds()?

optional onAdjustBounds: (self, value) => void

Defined in: react/src/generated/jsx.ts:4586

Emitted before clamping a value, to give the application a chance to adjust the bounds.

Parameters

Parameter	Type
self	Range
value	number

Returns

void

Inherited from

RangeProps.onAdjustBounds

---

onChangeValue()?

optional onChangeValue: (self, scroll, value) => boolean

Defined in: react/src/generated/jsx.ts:4601

Emitted when a scroll action is performed on a range.

It allows an application to determine the type of scroll event that occurred and the resultant new value. The application can handle the event itself and return %TRUE to prevent further processing. Or, by returning %FALSE, it can pass the event to other handlers until the default GTK handler is reached.

The value parameter is unrounded. An application that overrides the ::change-value signal is responsible for clamping the value to the desired number of decimal digits; the default GTK handler clamps the value based on [property@Gtk.Range:round-digits].

Parameters

Parameter	Type
self	Range
scroll	ScrollType
value	number

Returns

boolean

Inherited from

RangeProps.onChangeValue

---

onDestroy()?

optional onDestroy: (self) => void

Defined in: react/src/generated/jsx.ts:593

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onDestroy

---

onDirectionChanged()?

optional onDirectionChanged: (self, previousDirection) => void

Defined in: react/src/generated/jsx.ts:595

Emitted when the text direction of a widget changes.

Parameters

Parameter	Type
self	Widget
previousDirection	TextDirection

Returns

void

Inherited from

RangeProps.onDirectionChanged

---

onHide()?

optional onHide: (self) => void

Defined in: react/src/generated/jsx.ts:600

Emitted when widget is hidden.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onHide

---

onKeynavFailed()?

optional onKeynavFailed: (self, direction) => boolean

Defined in: react/src/generated/jsx.ts:606

Emitted if keyboard navigation fails.

See [method@Gtk.Widget.keynav_failed] for details.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

boolean

Inherited from

RangeProps.onKeynavFailed

---

onMap()?

optional onMap: (self) => void

Defined in: react/src/generated/jsx.ts:618

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with [property@Gtk.Widget:visible]) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of [signal@Gtk.Widget::unmap].

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onMap

---

onMnemonicActivate()?

optional onMnemonicActivate: (self, groupCycling) => boolean

Defined in: react/src/generated/jsx.ts:624

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.

Parameters

Parameter	Type
self	Widget
groupCycling	boolean

Returns

boolean

Inherited from

RangeProps.onMnemonicActivate

---

onMoveFocus()?

optional onMoveFocus: (self, direction) => void

Defined in: react/src/generated/jsx.ts:633

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

void

Inherited from

RangeProps.onMoveFocus

---

onMoveSlider()?

optional onMoveSlider: (self, step) => void

Defined in: react/src/generated/jsx.ts:4611

Virtual function that moves the slider.

Used for keybindings.

Parameters

Parameter	Type
self	Range
step	ScrollType

Returns

void

Inherited from

RangeProps.onMoveSlider

---

onQueryTooltip()?

optional onQueryTooltip: (self, x, y, keyboardMode, tooltip) => boolean

Defined in: react/src/generated/jsx.ts:648

Emitted when the widget’s tooltip is about to be shown.

This happens when the [property@Gtk.Widget:has-tooltip] property is true and the hover timeout has expired with the cursor hovering above @widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

Parameters

Parameter	Type
self	Widget
x	number
y	number
keyboardMode	boolean
tooltip	Tooltip

Returns

boolean

Inherited from

RangeProps.onQueryTooltip

---

onRealize()?

optional onRealize: (self) => void

Defined in: react/src/generated/jsx.ts:661

Emitted when widget is associated with a GdkSurface.

This means that [method@Gtk.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onRealize

---

onShow()?

optional onShow: (self) => void

Defined in: react/src/generated/jsx.ts:663

Emitted when widget is shown.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onShow

---

onStateFlagsChanged()?

optional onStateFlagsChanged: (self, flags) => void

Defined in: react/src/generated/jsx.ts:669

Emitted when the widget state changes.

See [method@Gtk.Widget.get_state_flags].

Parameters

Parameter	Type
self	Widget
flags	StateFlags

Returns

void

Inherited from

RangeProps.onStateFlagsChanged

---

onUnmap()?

optional onUnmap: (self) => void

Defined in: react/src/generated/jsx.ts:679

Emitted when widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onUnmap

---

onUnrealize()?

optional onUnrealize: (self) => void

Defined in: react/src/generated/jsx.ts:686

Emitted when the GdkSurface associated with widget is destroyed.

This means that [method@Gtk.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

RangeProps.onUnrealize

---

onValueChanged()?

optional onValueChanged: (self) => void

Defined in: react/src/generated/jsx.ts:4613

Emitted when the range value changes.

Parameters

Parameter	Type
self	Range

Returns

void

Inherited from

RangeProps.onValueChanged

---

opacity?

optional opacity: number

Defined in: react/src/generated/jsx.ts:517

The requested opacity of the widget.

Inherited from

RangeProps.opacity

---

orientation

orientation: Orientation

Defined in: react/src/generated/jsx.ts:4642

The orientation of the orientable.

Overrides

RangeProps.orientation

---

overflow?

optional overflow: Overflow

Defined in: react/src/generated/jsx.ts:524

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

RangeProps.overflow

---

parent?

optional parent: Widget

Defined in: react/src/generated/jsx.ts:526

The parent widget of this widget.

Inherited from

RangeProps.parent

---

receivesDefault?

optional receivesDefault: boolean

Defined in: react/src/generated/jsx.ts:528

Whether the widget will receive the default action when it is focused.

Inherited from

RangeProps.receivesDefault

---

ref?

optional ref: Ref<Scale>

Defined in: react/src/generated/jsx.ts:4644

Overrides

RangeProps.ref

---

restrictToFillLevel?

optional restrictToFillLevel: boolean

Defined in: react/src/generated/jsx.ts:4566

Controls whether slider movement is restricted to an upper boundary set by the fill level.

Inherited from

RangeProps.restrictToFillLevel

---

root?

optional root: Root

Defined in: react/src/generated/jsx.ts:534

The GtkRoot widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Inherited from

RangeProps.root

---

roundDigits?

optional roundDigits: number

Defined in: react/src/generated/jsx.ts:4573

The number of digits to round the value to when it changes.

See [signal@Gtk.Range::change-value].

Inherited from

RangeProps.roundDigits

---

scaleFactor?

optional scaleFactor: number

Defined in: react/src/generated/jsx.ts:536

The scale factor of the widget.

Inherited from

RangeProps.scaleFactor

---

sensitive?

optional sensitive: boolean

Defined in: react/src/generated/jsx.ts:538

Whether the widget responds to input.

Inherited from

RangeProps.sensitive

---

showFillLevel?

optional showFillLevel: boolean

Defined in: react/src/generated/jsx.ts:4578

Controls whether fill level indicator graphics are displayed on the trough.

Inherited from

RangeProps.showFillLevel

---

tooltipMarkup?

optional tooltipMarkup: string

Defined in: react/src/generated/jsx.ts:554

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [method@Gtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

RangeProps.tooltipMarkup

---

tooltipText?

optional tooltipText: string

Defined in: react/src/generated/jsx.ts:569

Sets the text of tooltip to be the given string.

Also see [method@Gtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

RangeProps.tooltipText

---

valign?

optional valign: Align

Defined in: react/src/generated/jsx.ts:571

How to distribute vertical space if widget gets extra space.

Inherited from

RangeProps.valign

---

valuePos?

optional valuePos: PositionType

Defined in: react/src/generated/jsx.ts:4641

The position in which the current value is displayed.

---

vexpand?

optional vexpand: boolean

Defined in: react/src/generated/jsx.ts:573

Whether to expand vertically.

Inherited from

RangeProps.vexpand

---

vexpandSet?

optional vexpandSet: boolean

Defined in: react/src/generated/jsx.ts:575

Whether to use the vexpand property.

Inherited from

RangeProps.vexpandSet

---

visible?

optional visible: boolean

Defined in: react/src/generated/jsx.ts:577

Whether the widget is visible.

Inherited from

RangeProps.visible

---

widthRequest?

optional widthRequest: number

Defined in: react/src/generated/jsx.ts:583

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Inherited from

RangeProps.widthRequest