Package org.gnome.gtk

Class Switch

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.Switch

All Implemented Interfaces:

Proxy, Accessible, Actionable, Buildable, ConstraintTarget

@Generated("io.github.jwharm.JavaGI")
public class Switch
extends Widget
implements Accessible, Actionable, Buildable, ConstraintTarget

Shows a "light switch" that has two states: on or off.

<picture> <source srcset="switch-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkSwitch" src="switch.png"> </picture>

The user can control which state should be active by clicking the empty area, or by dragging the slider.

GtkSwitch can also express situations where the underlying state changes with a delay. In this case, the slider position indicates the user's recent change (represented by the Gtk.Switch:active property), while the trough color indicates the present underlying state (represented by the Gtk.Switch:state property).

<picture> <source srcset="switch-state-dark.png" media="(prefers-color-scheme: dark)"> <img alt="GtkSwitch with delayed state change" src="switch-state.png"> </picture>

See Gtk.Switch::state-set for details.

Shortcuts and Gestures
GtkSwitch supports pan and drag gestures to move the slider.

CSS nodes

 switch
 ├── image
 ├── image
 ╰── slider
 

GtkSwitch has four css nodes, the main node with the name switch and subnodes for the slider and the on and off images. Neither of them is using any style classes.

Accessibility
GtkSwitch uses the Gtk.AccessibleRole.switch role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Switch.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	Switch.Builder<B extends Switch.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Switch.StateSetCallback	Functional interface declaration of the StateSetCallback callback.

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

Actionable.ActionableImpl, Actionable.ActionableInterface

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

Field Summary

Fields inherited from class io.github.jwharm.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Switch	asParent()	Returns this instance as if it were its parent type.
static Switch.Builder<? extends Switch.Builder>	builder()	A Switch.Builder object constructs a Switch with the specified properties.
void	emitActivate()	Emits the "activate" signal.
boolean	emitStateSet(boolean state)	Emits the "state-set" signal.
boolean	getActive()	Gets whether the GtkSwitch is in its “on” or “off” state.
boolean	getState()	Gets the underlying state of the GtkSwitch.
static Type	getType()	Get the GType of the Switch class
SignalConnection<Switch.ActivateCallback>	onActivate(Switch.ActivateCallback handler)	Emitted to animate the switch.
SignalConnection<Switch.StateSetCallback>	onStateSet(Switch.StateSetCallback handler)	Emitted to change the underlying state.
void	setActive(boolean isActive)	Changes the state of this Switch to the desired one.
void	setState(boolean state)	Sets the underlying state of the GtkSwitch.

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, getMemoryLayout, 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, 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, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Actionable

getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionName

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

Switch

public Switch(MemorySegment address)

Create a Switch proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Switch

public Switch()

Creates a new Switch.

Method Details

getType

public static Type getType()

Get the GType of the Switch class

Returns:

the GType

asParent

protected Switch 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 Widget

getActive

public boolean getActive()

Gets whether the GtkSwitch is in its “on” or “off” state.

Returns:

true if the GtkSwitch is active, and false otherwise

getState

public boolean getState()

Gets the underlying state of the GtkSwitch.

Returns:

the underlying state

setActive

public void setActive(boolean isActive)

Changes the state of this Switch to the desired one.

Parameters:

isActive - true if this Switch should be active, and false otherwise

setState

public void setState(boolean state)

Sets the underlying state of the GtkSwitch.

This function is typically called from a Gtk.Switch::state-set signal handler in order to set up delayed state changes.

See Gtk.Switch::state-set for details.

Parameters:

state - the new state

onActivate

public SignalConnection<Switch.ActivateCallback> onActivate(Switch.ActivateCallback handler)

Emitted to animate the switch.

Applications should never connect to this signal, but use the Gtk.Switch:active property.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Switch.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.gtk.Switch.ActivateCallback).

onStateSet

public SignalConnection<Switch.StateSetCallback> onStateSet(Switch.StateSetCallback handler)

Emitted to change the underlying state.

The ::state-set signal is emitted when the user changes the switch position. The default handler calls setState(boolean) with the value of state.

To implement delayed state change, applications can connect to this signal, initiate the change of the underlying state, and call setState(boolean) when the underlying state change is complete. The signal handler should return true to prevent the default handler from running.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Switch.StateSetCallback.run(boolean)

emitStateSet

public boolean emitStateSet(boolean state)

Emits the "state-set" signal. See onStateSet(org.gnome.gtk.Switch.StateSetCallback).

builder

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

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