Package org.gnome.adw

Class Toggle

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.Toggle

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class Toggle
extends GObject

A toggle within ToggleGroup.

AdwToggle can optionally have a name, set with Toggle:name. If the name is set, ToggleGroup:active-name can be used to access toggles instead of index.

Since:

1.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Toggle.Builder<B extends Toggle.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Toggle.ToggleClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Toggle	asParent()	Returns this instance as if it were its parent type.
static Toggle.Builder<? extends Toggle.Builder>	builder()	A Toggle.Builder object constructs a Toggle with the specified properties.
@Nullable Widget	getChild()	Gets the child widget of self.
boolean	getEnabled()	Gets whether this Toggle is enabled.
@Nullable String	getIconName()	Gets the icon name of self.
int	getIndex()	Gets the index of this Toggle within its toggle group.
@Nullable String	getLabel()	Gets the label of self.
String	getName()	Gets the name of self.
String	getTooltip()	Gets the tooltip of self.
static @Nullable Type	getType()	Get the GType of the Toggle class
boolean	getUseUnderline()	Gets whether this Toggle uses underlines.
void	setChild(@Nullable Widget child)	Sets the child of this Toggle to child.
void	setEnabled(boolean enabled)	Sets whether this Toggle is enabled.
void	setIconName(@Nullable String iconName)	Sets the icon name of this Toggle to iconName.
void	setLabel(@Nullable String label)	Sets the label of this Toggle to label.
void	setName(@Nullable String name)	Sets the name of this Toggle to name.
void	setTooltip(String tooltip)	Sets the tooltip of this Toggle to tooltip.
void	setUseUnderline(boolean useUnderline)	Sets whether an embedded underline in the label indicates a mnemonic.

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, getMemoryLayout, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Toggle

public Toggle(MemorySegment address)

Create a Toggle proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Toggle

public Toggle()

Creates a new Toggle.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Toggle class

Returns:

the GType

asParent

protected Toggle 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 GObject

getChild

public @Nullable Widget getChild()

Gets the child widget of self.

Returns:

the toggle child

Since:

1.7

getEnabled

public boolean getEnabled()

Gets whether this Toggle is enabled.

Returns:

whether the toggle is enabled

Since:

1.7

getIconName

public @Nullable String getIconName()

Gets the icon name of self.

Returns:

the toggle icon name

Since:

1.7

getIndex

public int getIndex()

Gets the index of this Toggle within its toggle group.

Returns:

the index, or GTK_INVALID_LIST_POSITION if it's not in a group

Since:

1.7

getLabel

public @Nullable String getLabel()

Gets the label of self.

Returns:

the toggle label

Since:

1.7

getName

public String getName()

Gets the name of self.

Returns:

the toggle name

Since:

1.7

getTooltip

public String getTooltip()

Gets the tooltip of self.

Returns:

the toggle tooltip

Since:

1.7

getUseUnderline

public boolean getUseUnderline()

Gets whether this Toggle uses underlines.

Returns:

whether the toggle uses underlines

Since:

1.7

setChild

public void setChild(@Nullable Widget child)

Sets the child of this Toggle to child.

When the child is set, icon and label are not displayed.

It's recommended to still set the label, as it can still be used by the screen reader.

Parameters:

child - a child widget

Since:

1.7

setEnabled

public void setEnabled(boolean enabled)

Sets whether this Toggle is enabled.

Parameters:

enabled - whether the toggle should be enbled

Since:

1.7

setIconName

public void setIconName(@Nullable String iconName)

Sets the icon name of this Toggle to iconName.

The icon will be displayed alone or next to the label, unless Toggle:child is set.

Parameters:

iconName - the icon name

Since:

1.7

setLabel

public void setLabel(@Nullable String label)

Sets the label of this Toggle to label.

The label will be displayed alone or next to the icon, unless Toggle:child is set, but will still be read out by the screen reader.

Parameters:

label - a label

Since:

1.7

setName

public void setName(@Nullable String name)

Sets the name of this Toggle to name.

Allows accessing this Toggle by its name instead of index.

See ToggleGroup:active-name.

Parameters:

name - a name

Since:

1.7

setTooltip

public void setTooltip(String tooltip)

Sets the tooltip of this Toggle to tooltip.

tooltip can be marked up with the Pango text markup language.

Parameters:

tooltip - the tooltip

Since:

1.7

setUseUnderline

public void setUseUnderline(boolean useUnderline)

Sets whether an embedded underline in the label indicates a mnemonic.

See Toggle:label.

Parameters:

useUnderline - whether an underline in the label indicates a mnemonic

Since:

1.7

builder

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

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

Returns:

the builder object