@gtkx/react / GtkScaleProps
Interface: GtkScaleProps
Defined in: packages/react/src/generated/jsx.ts:6170
Props for the GtkScale widget.
Extends
Properties
accessibleActiveDescendant?
optionalaccessibleActiveDescendant?:Widget
Defined in: packages/react/src/jsx.ts:834
Inherited from
GtkRangeProps.accessibleActiveDescendant
accessibleAutocomplete?
optionalaccessibleAutocomplete?:AccessibleAutocomplete
Defined in: packages/react/src/jsx.ts:803
Inherited from
GtkRangeProps.accessibleAutocomplete
accessibleBusy?
optionalaccessibleBusy?:boolean
Defined in: packages/react/src/jsx.ts:824
Inherited from
accessibleChecked?
optionalaccessibleChecked?:AccessibleTristate
Defined in: packages/react/src/jsx.ts:825
Inherited from
GtkRangeProps.accessibleChecked
accessibleColCount?
optionalaccessibleColCount?:number
Defined in: packages/react/src/jsx.ts:835
Inherited from
GtkRangeProps.accessibleColCount
accessibleColIndex?
optionalaccessibleColIndex?:number
Defined in: packages/react/src/jsx.ts:836
Inherited from
GtkRangeProps.accessibleColIndex
accessibleColIndexText?
optionalaccessibleColIndexText?:string
Defined in: packages/react/src/jsx.ts:837
Inherited from
GtkRangeProps.accessibleColIndexText
accessibleColSpan?
optionalaccessibleColSpan?:number
Defined in: packages/react/src/jsx.ts:838
Inherited from
GtkRangeProps.accessibleColSpan
accessibleControls?
optionalaccessibleControls?:Widget[]
Defined in: packages/react/src/jsx.ts:839
Inherited from
GtkRangeProps.accessibleControls
accessibleDescribedBy?
optionalaccessibleDescribedBy?:Widget[]
Defined in: packages/react/src/jsx.ts:840
Inherited from
GtkRangeProps.accessibleDescribedBy
accessibleDescription?
optionalaccessibleDescription?:string
Defined in: packages/react/src/jsx.ts:804
Inherited from
GtkRangeProps.accessibleDescription
accessibleDetails?
optionalaccessibleDetails?:Widget[]
Defined in: packages/react/src/jsx.ts:841
Inherited from
GtkRangeProps.accessibleDetails
accessibleDisabled?
optionalaccessibleDisabled?:boolean
Defined in: packages/react/src/jsx.ts:826
Inherited from
GtkRangeProps.accessibleDisabled
accessibleErrorMessage?
optionalaccessibleErrorMessage?:Widget[]
Defined in: packages/react/src/jsx.ts:842
Inherited from
GtkRangeProps.accessibleErrorMessage
accessibleExpanded?
optionalaccessibleExpanded?:boolean
Defined in: packages/react/src/jsx.ts:827
Inherited from
GtkRangeProps.accessibleExpanded
accessibleFlowTo?
optionalaccessibleFlowTo?:Widget[]
Defined in: packages/react/src/jsx.ts:843
Inherited from
GtkRangeProps.accessibleFlowTo
accessibleHasPopup?
optionalaccessibleHasPopup?:boolean
Defined in: packages/react/src/jsx.ts:805
Inherited from
GtkRangeProps.accessibleHasPopup
accessibleHelpText?
optionalaccessibleHelpText?:string
Defined in: packages/react/src/jsx.ts:822
Inherited from
GtkRangeProps.accessibleHelpText
accessibleHidden?
optionalaccessibleHidden?:boolean
Defined in: packages/react/src/jsx.ts:828
Inherited from
GtkRangeProps.accessibleHidden
accessibleInvalid?
optionalaccessibleInvalid?:AccessibleInvalidState
Defined in: packages/react/src/jsx.ts:829
Inherited from
GtkRangeProps.accessibleInvalid
accessibleKeyShortcuts?
optionalaccessibleKeyShortcuts?:string
Defined in: packages/react/src/jsx.ts:806
Inherited from
GtkRangeProps.accessibleKeyShortcuts
accessibleLabel?
optionalaccessibleLabel?:string
Defined in: packages/react/src/jsx.ts:807
Inherited from
accessibleLabelledBy?
optionalaccessibleLabelledBy?:Widget[]
Defined in: packages/react/src/jsx.ts:844
Inherited from
GtkRangeProps.accessibleLabelledBy
accessibleLevel?
optionalaccessibleLevel?:number
Defined in: packages/react/src/jsx.ts:808
Inherited from
accessibleModal?
optionalaccessibleModal?:boolean
Defined in: packages/react/src/jsx.ts:809
Inherited from
accessibleMultiLine?
optionalaccessibleMultiLine?:boolean
Defined in: packages/react/src/jsx.ts:810
Inherited from
GtkRangeProps.accessibleMultiLine
accessibleMultiSelectable?
optionalaccessibleMultiSelectable?:boolean
Defined in: packages/react/src/jsx.ts:811
Inherited from
GtkRangeProps.accessibleMultiSelectable
accessibleOrientation?
optionalaccessibleOrientation?:Orientation
Defined in: packages/react/src/jsx.ts:812
Inherited from
GtkRangeProps.accessibleOrientation
accessibleOwns?
optionalaccessibleOwns?:Widget[]
Defined in: packages/react/src/jsx.ts:845
Inherited from
accessiblePlaceholder?
optionalaccessiblePlaceholder?:string
Defined in: packages/react/src/jsx.ts:813
Inherited from
GtkRangeProps.accessiblePlaceholder
accessiblePosInSet?
optionalaccessiblePosInSet?:number
Defined in: packages/react/src/jsx.ts:846
Inherited from
GtkRangeProps.accessiblePosInSet
accessiblePressed?
optionalaccessiblePressed?:AccessibleTristate
Defined in: packages/react/src/jsx.ts:830
Inherited from
GtkRangeProps.accessiblePressed
accessibleReadOnly?
optionalaccessibleReadOnly?:boolean
Defined in: packages/react/src/jsx.ts:814
Inherited from
GtkRangeProps.accessibleReadOnly
accessibleRequired?
optionalaccessibleRequired?:boolean
Defined in: packages/react/src/jsx.ts:815
Inherited from
GtkRangeProps.accessibleRequired
accessibleRole?
optionalaccessibleRole?:AccessibleRole
Defined in: packages/react/src/generated/jsx.ts:187
The accessible role of the given GtkAccessible implementation.
The accessible role cannot be changed once set.
Inherited from
accessibleRoleDescription?
optionalaccessibleRoleDescription?:string
Defined in: packages/react/src/jsx.ts:816
Inherited from
GtkRangeProps.accessibleRoleDescription
accessibleRowCount?
optionalaccessibleRowCount?:number
Defined in: packages/react/src/jsx.ts:847
Inherited from
GtkRangeProps.accessibleRowCount
accessibleRowIndex?
optionalaccessibleRowIndex?:number
Defined in: packages/react/src/jsx.ts:848
Inherited from
GtkRangeProps.accessibleRowIndex
accessibleRowIndexText?
optionalaccessibleRowIndexText?:string
Defined in: packages/react/src/jsx.ts:849
Inherited from
GtkRangeProps.accessibleRowIndexText
accessibleRowSpan?
optionalaccessibleRowSpan?:number
Defined in: packages/react/src/jsx.ts:850
Inherited from
GtkRangeProps.accessibleRowSpan
accessibleSelected?
optionalaccessibleSelected?:boolean
Defined in: packages/react/src/jsx.ts:831
Inherited from
GtkRangeProps.accessibleSelected
accessibleSetSize?
optionalaccessibleSetSize?:number
Defined in: packages/react/src/jsx.ts:851
Inherited from
GtkRangeProps.accessibleSetSize
accessibleSort?
optionalaccessibleSort?:AccessibleSort
Defined in: packages/react/src/jsx.ts:817
Inherited from
accessibleValueMax?
optionalaccessibleValueMax?:number
Defined in: packages/react/src/jsx.ts:818
Inherited from
GtkRangeProps.accessibleValueMax
accessibleValueMin?
optionalaccessibleValueMin?:number
Defined in: packages/react/src/jsx.ts:819
Inherited from
GtkRangeProps.accessibleValueMin
accessibleValueNow?
optionalaccessibleValueNow?:number
Defined in: packages/react/src/jsx.ts:820
Inherited from
GtkRangeProps.accessibleValueNow
accessibleValueText?
optionalaccessibleValueText?:string
Defined in: packages/react/src/jsx.ts:821
Inherited from
GtkRangeProps.accessibleValueText
accessibleVisited?
optionalaccessibleVisited?:boolean
Defined in: packages/react/src/jsx.ts:832
Inherited from
GtkRangeProps.accessibleVisited
canFocus?
optionalcanFocus?:boolean
Defined in: packages/react/src/generated/jsx.ts:24
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
canTarget?
optionalcanTarget?:boolean
Defined in: packages/react/src/generated/jsx.ts:26
Whether the widget can receive pointer events.
Inherited from
children?
optionalchildren?:ReactNode
Defined in: packages/react/src/generated/jsx.ts:312
Children elements (child widgets or event controllers).
Inherited from
cssClasses?
optionalcssClasses?:string[]
Defined in: packages/react/src/generated/jsx.ts:28
A list of css classes applied to this widget.
Inherited from
cssName?
optionalcssName?:string
Defined in: packages/react/src/generated/jsx.ts:35
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
cursor?
optionalcursor?:Cursor|null
Defined in: packages/react/src/generated/jsx.ts:37
The cursor used by widget.
Inherited from
digits?
optionaldigits?:number
Defined in: packages/react/src/generated/jsx.ts:6172
The number of decimal places that are displayed in the value.
drawValue?
optionaldrawValue?:boolean
Defined in: packages/react/src/generated/jsx.ts:6174
Whether the current value is displayed as a string next to the slider.
fillLevel?
optionalfillLevel?:number
Defined in: packages/react/src/generated/jsx.ts:6105
The fill level (e.g. prebuffering of a network stream).
Inherited from
focusable?
optionalfocusable?:boolean
Defined in: packages/react/src/generated/jsx.ts:45
Whether this widget itself will accept the input focus.
Inherited from
focusOnClick?
optionalfocusOnClick?:boolean
Defined in: packages/react/src/generated/jsx.ts:43
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
halign?
optionalhalign?:Align
Defined in: packages/react/src/generated/jsx.ts:47
How to distribute horizontal space if widget gets extra space.
Inherited from
hasOrigin?
optionalhasOrigin?:boolean
Defined in: packages/react/src/generated/jsx.ts:6176
Whether the scale has an origin.
hasTooltip?
optionalhasTooltip?:boolean
Defined in: packages/react/src/generated/jsx.ts:56
Enables or disables the emission of the 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 Widget.:query-tooltip to determine whether it will provide a tooltip or not.
Inherited from
heightRequest?
optionalheightRequest?:number
Defined in: packages/react/src/generated/jsx.ts:62
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Inherited from
hexpand?
optionalhexpand?:boolean
Defined in: packages/react/src/generated/jsx.ts:64
Whether to expand horizontally.
Inherited from
hexpandSet?
optionalhexpandSet?:boolean
Defined in: packages/react/src/generated/jsx.ts:66
Whether to use the hexpand property.
Inherited from
inverted?
optionalinverted?:boolean
Defined in: packages/react/src/generated/jsx.ts:6107
If %TRUE, the direction in which the slider moves is inverted.
Inherited from
layoutManager?
optionallayoutManager?:LayoutManager|null
Defined in: packages/react/src/generated/jsx.ts:74
The 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
limitEvents?
optionallimitEvents?:boolean
Defined in: packages/react/src/generated/jsx.ts:83
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 EventController.set_propagation_limit.
Inherited from
lower?
optionallower?:number
Defined in: packages/react/src/jsx.ts:748
The minimum allowed value
Inherited from
GtkRangeProps.lower
marginBottom?
optionalmarginBottom?:number
Defined in: packages/react/src/generated/jsx.ts:91
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 Widget.set_size_request for example.
Inherited from
marginEnd?
optionalmarginEnd?:number
Defined in: packages/react/src/generated/jsx.ts:102
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 Widget.set_size_request for example.
Inherited from
marginStart?
optionalmarginStart?:number
Defined in: packages/react/src/generated/jsx.ts:113
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 Widget.set_size_request for example.
Inherited from
marginTop?
optionalmarginTop?:number
Defined in: packages/react/src/generated/jsx.ts:121
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 Widget.set_size_request for example.
Inherited from
marks?
optionalmarks?:object[] |null
Defined in: packages/react/src/jsx.ts:864
Visual marks placed along the scale at specific values
name?
optionalname?:string
Defined in: packages/react/src/generated/jsx.ts:123
The name of the widget.
Inherited from
onAdjustBounds?
optionalonAdjustBounds?: ((value,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:6131
Emitted before clamping a value, to give the application a chance to adjust the bounds.
Inherited from
onChangeValue?
optionalonChangeValue?: ((scroll,value,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:6146
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 Range.round-digits.
Inherited from
onDestroy?
optionalonDestroy?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:196
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.
Inherited from
onDirectionChanged?
optionalonDirectionChanged?: ((previousDirection,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:198
Emitted when the text direction of a widget changes.
Inherited from
GtkRangeProps.onDirectionChanged
onHide?
optionalonHide?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:200
Emitted when widget is hidden.
Inherited from
onKeynavFailed?
optionalonKeynavFailed?: ((direction,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:206
Emitted if keyboard navigation fails.
See Widget.keynav_failed for details.
Inherited from
onMap?
optionalonMap?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:218
Emitted when widget is going to be mapped.
A widget is mapped when the widget is visible (which is controlled with 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 Widget.:unmap.
Inherited from
onMnemonicActivate?
optionalonMnemonicActivate?: ((groupCycling,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:225
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.
Inherited from
GtkRangeProps.onMnemonicActivate
onMoveFocus?
optionalonMoveFocus?: ((direction,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:234
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.
Inherited from
onMoveSlider?
optionalonMoveSlider?: ((step,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:6152
Virtual function that moves the slider.
Used for keybindings.
Inherited from
onNotify?
optionalonNotify?: ((pspec,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:310
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.
This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:
|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|
It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.
Inherited from
onQueryTooltip?
optionalonQueryTooltip?: ((x,y,keyboardMode,tooltip,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:250
Emitted when the widget’s tooltip is about to be shown.
This happens when the 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.
Inherited from
onRealize?
optionalonRealize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:257
Emitted when widget is associated with a GdkSurface.
This means that Widget.realize has been called or the widget has been mapped (that is, it is going to be drawn).
Inherited from
onShow?
optionalonShow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:259
Emitted when widget is shown.
Inherited from
onStateFlagsChanged?
optionalonStateFlagsChanged?: ((flags,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:265
Emitted when the widget state changes.
Inherited from
GtkRangeProps.onStateFlagsChanged
onUnmap?
optionalonUnmap?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:275
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.
Inherited from
onUnrealize?
optionalonUnrealize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:282
Emitted when the GdkSurface associated with widget is destroyed.
This means that Widget.unrealize has been called or the widget has been unmapped (that is, it is going to be hidden).
Inherited from
onValueChanged?
optionalonValueChanged?: ((value,self) =>void) |null
Defined in: packages/react/src/jsx.ts:859
Callback fired when the range value changes
Inherited from
opacity?
optionalopacity?:number
Defined in: packages/react/src/generated/jsx.ts:125
The requested opacity of the widget.
Inherited from
orientation?
optionalorientation?:Orientation
Defined in: packages/react/src/generated/jsx.ts:6126
The orientation of the orientable.
Inherited from
overflow?
optionaloverflow?:Overflow
Defined in: packages/react/src/generated/jsx.ts:132
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
pageIncrement?
optionalpageIncrement?:number
Defined in: packages/react/src/jsx.ts:754
The page increment for larger adjustments
Inherited from
GtkRangeProps.pageIncrement
pageSize?
optionalpageSize?:number
Defined in: packages/react/src/jsx.ts:756
The size of the visible portion (for scrollbars)
Inherited from
GtkRangeProps.pageSize
receivesDefault?
optionalreceivesDefault?:boolean
Defined in: packages/react/src/generated/jsx.ts:134
Whether the widget will receive the default action when it is focused.
Inherited from
ref?
optionalref?:Ref<Scale>
Defined in: packages/react/src/generated/jsx.ts:6179
Overrides
restrictToFillLevel?
optionalrestrictToFillLevel?:boolean
Defined in: packages/react/src/generated/jsx.ts:6112
Controls whether slider movement is restricted to an upper boundary set by the fill level.
Inherited from
GtkRangeProps.restrictToFillLevel
roundDigits?
optionalroundDigits?:number
Defined in: packages/react/src/generated/jsx.ts:6119
The number of digits to round the value to when it changes.
See Range.:change-value.
Inherited from
sensitive?
optionalsensitive?:boolean
Defined in: packages/react/src/generated/jsx.ts:136
Whether the widget responds to input.
Inherited from
showFillLevel?
optionalshowFillLevel?:boolean
Defined in: packages/react/src/generated/jsx.ts:6124
Controls whether fill level indicator graphics are displayed on the trough.
Inherited from
stepIncrement?
optionalstepIncrement?:number
Defined in: packages/react/src/jsx.ts:752
The step increment for small adjustments
Inherited from
GtkRangeProps.stepIncrement
tooltipMarkup?
optionaltooltipMarkup?:string|null
Defined in: packages/react/src/generated/jsx.ts:152
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Tooltip.set_markup.
This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: Widget.has-tooltip will automatically be set to true and there will be taken care of Widget.:query-tooltip in the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
tooltipText?
optionaltooltipText?:string|null
Defined in: packages/react/src/generated/jsx.ts:167
Sets the text of tooltip to be the given string.
Also see Tooltip.set_text.
This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: Widget.has-tooltip will automatically be set to true and there will be taken care of Widget.:query-tooltip in the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
upper?
optionalupper?:number
Defined in: packages/react/src/jsx.ts:750
The maximum allowed value
Inherited from
GtkRangeProps.upper
valign?
optionalvalign?:Align
Defined in: packages/react/src/generated/jsx.ts:169
How to distribute vertical space if widget gets extra space.
Inherited from
value?
optionalvalue?:number
Defined in: packages/react/src/jsx.ts:746
The current value of the adjustable
Inherited from
GtkRangeProps.value
valuePos?
optionalvaluePos?:PositionType
Defined in: packages/react/src/generated/jsx.ts:6178
The position in which the current value is displayed.
vexpand?
optionalvexpand?:boolean
Defined in: packages/react/src/generated/jsx.ts:171
Whether to expand vertically.
Inherited from
vexpandSet?
optionalvexpandSet?:boolean
Defined in: packages/react/src/generated/jsx.ts:173
Whether to use the vexpand property.
Inherited from
visible?
optionalvisible?:boolean
Defined in: packages/react/src/generated/jsx.ts:175
Whether the widget is visible.
Inherited from
widthRequest?
optionalwidthRequest?:number
Defined in: packages/react/src/generated/jsx.ts:181
Overrides for width request of the widget.
If this is -1, the natural request will be used.