Package org.gnome.adw

Class TabButton

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.TabButton

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

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

A button that displays the number of TabView pages.

AdwTabButton is a button that displays the number of pages in a given AdwTabView, as well as whether one of the inactive pages needs attention.

It's intended to be used as a visible indicator when there's no visible tab bar, typically opening an TabOverview on click, e.g. via the overview.open action name:

<object class="AdwTabButton">
   <property name="view">view</property>
   <property name="action-name">overview.open</property>
 </object>
 

CSS nodes
AdwTabButton has a main CSS node with name tabbutton.

Accessibility
AdwTabButton uses the GTK_ACCESSIBLE_ROLE_BUTTON role.

Since:

1.3

Nested Class Summary

Nested Classes

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

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.Widget$Impl, Widget.WidgetClass

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.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Actionable

Actionable.Actionable$Impl, Actionable.ActionableInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected TabButton	asParent()	Returns this instance as if it were its parent type.
static TabButton.Builder<? extends TabButton.Builder>	builder()	A TabButton.Builder object constructs a TabButton with the specified properties.
void	emitActivate()	Emits the "activate" signal.
void	emitClicked()	Emits the "clicked" signal.
static @Nullable Type	getType()	Get the GType of the TabButton class
@Nullable TabView	getView()	Gets the tab view this TabButton displays.
SignalConnection<TabButton.ActivateCallback>	onActivate(TabButton.ActivateCallback handler)	Emitted to animate press then release.
SignalConnection<TabButton.ClickedCallback>	onClicked(TabButton.ClickedCallback handler)	Emitted when the button has been activated (pressed and released).
void	setView(@Nullable TabView view)	Sets the tab view to display.

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, 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

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 org.javagi.base.Proxy

handle

Constructor Details

TabButton

public TabButton(MemorySegment address)

Create a TabButton proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

TabButton

public TabButton()

Creates a new TabButton.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the TabButton class

Returns:

the GType

asParent

protected TabButton 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

getView

public @Nullable TabView getView()

Gets the tab view this TabButton displays.

Returns:

the tab view

Since:

1.3

setView

public void setView(@Nullable TabView view)

Sets the tab view to display.

Parameters:

view - a tab view

Since:

1.3

onActivate

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

Emitted to animate press then release.

This is an action signal. Applications should never connect to this signal, but use the TabButton::clicked signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.3

See Also:

• TabButton.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.adw.TabButton.ActivateCallback).

onClicked

public SignalConnection<TabButton.ClickedCallback> onClicked(TabButton.ClickedCallback handler)

Emitted when the button has been activated (pressed and released).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.3

See Also:

• TabButton.ClickedCallback.run()

emitClicked

public void emitClicked()

Emits the "clicked" signal. See onClicked(org.gnome.adw.TabButton.ClickedCallback).

builder

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

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

Returns:

the builder object