Package org.gnome.gtk

Class LinkButton

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.gtk.Button

org.gnome.gtk.LinkButton

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

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

A button with a hyperlink.

It is useful to show quick links to resources.

A link button is created by calling either LinkButton() or withLabel(java.lang.String, java.lang.String). If using the former, the URI you pass to the constructor is used as a label for the widget.

The URI bound to a GtkLinkButton can be set specifically using setUri(java.lang.String).

By default, GtkLinkButton calls FileLauncher.launch(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) when the button is clicked. This behaviour can be overridden by connecting to the Gtk.LinkButton::activate-link signal and returning true from the signal handler.

Shortcuts and Gestures
GtkLinkButton supports the following keyboard shortcuts:

• Shift+F10 or Menu opens the context menu.

Actions
GtkLinkButton defines a set of built-in actions:

• clipboard.copy copies the url to the clipboard.
• menu.popup opens the context menu.

CSS nodes
GtkLinkButton has a single CSS node with name button. To differentiate it from a plain GtkButton, it gets the .link style class.

Accessibility
GtkLinkButton uses the Gtk.AccessibleRole.link role.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.Button

Button.ActivateCallback, Button.ButtonClass, Button.ClickedCallback

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
LinkButton()	Creates a new LinkButton.
LinkButton(MemorySegment address)	Create a LinkButton proxy instance for the provided memory address.
LinkButton(String uri)	Creates a new GtkLinkButton with the URI as its text.

Method Summary

Modifier and Type	Method	Description
protected LinkButton	asParent()	Returns this instance as if it were its parent type.
static LinkButton.Builder<? extends LinkButton.Builder>	builder()	A LinkButton.Builder object constructs a LinkButton with the specified properties.
boolean	emitActivateLink()	Emits the "activate-link" signal.
static @Nullable Type	getType()	Get the GType of the LinkButton class
String	getUri()	Retrieves the URI of the GtkLinkButton.
boolean	getVisited()	Retrieves the “visited” state of the GtkLinkButton.
SignalConnection<LinkButton.ActivateLinkCallback>	onActivateLink(LinkButton.ActivateLinkCallback handler)	Emitted each time the GtkLinkButton is clicked.
void	setUri(String uri)	Sets uri as the URI where the GtkLinkButton points.
void	setVisited(boolean visited)	Sets the “visited” state of the GtkLinkButton.
static LinkButton	withLabel(String uri, @Nullable String label)	Creates a new GtkLinkButton containing a label.

Methods inherited from class org.gnome.gtk.Button

activate, clicked, emitActivate, emitClicked, fromIconName, getCanShrink, getChild, getHasFrame, getIconName, getLabel, getMemoryLayout, getUseUnderline, onActivate, onClicked, setCanShrink, setChild, setHasFrame, setIconName, setLabel, setUseUnderline, withLabel, withMnemonic

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

LinkButton

public LinkButton(MemorySegment address)

Create a LinkButton proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

LinkButton

public LinkButton(String uri)

Creates a new GtkLinkButton with the URI as its text.

Parameters:

uri - a valid URI

LinkButton

public LinkButton()

Creates a new LinkButton.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the LinkButton class

Returns:

the GType

asParent

protected LinkButton 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 Button

withLabel

public static LinkButton withLabel(String uri,
 @Nullable String label)

Creates a new GtkLinkButton containing a label.

Parameters:

uri - a valid URI

label - the text of the button

Returns:

a new link button widget.

getUri

public String getUri()

Retrieves the URI of the GtkLinkButton.

Returns:

a valid URI. The returned string is owned by the link button and should not be modified or freed.

getVisited

public boolean getVisited()

Retrieves the “visited” state of the GtkLinkButton.

The button becomes visited when it is clicked. If the URI is changed on the button, the “visited” state is unset again.

The state may also be changed using setVisited(boolean).

Returns:

true if the link has been visited, false otherwise

setUri

public void setUri(String uri)

Sets uri as the URI where the GtkLinkButton points.

As a side-effect this unsets the “visited” state of the button.

Parameters:

uri - a valid URI

setVisited

public void setVisited(boolean visited)

Sets the “visited” state of the GtkLinkButton.

See getVisited() for more details.

Parameters:

visited - the new “visited” state

onActivateLink

public SignalConnection<LinkButton.ActivateLinkCallback> onActivateLink(LinkButton.ActivateLinkCallback handler)

Emitted each time the GtkLinkButton is clicked.

The default handler will call FileLauncher.launch(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) with the URI stored inside the Gtk.LinkButton:uri property.

To override the default behavior, you can connect to the ::activate-link signal and stop the propagation of the signal by returning true from your handler.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• LinkButton.ActivateLinkCallback.run()

emitActivateLink

public boolean emitActivateLink()

Emits the "activate-link" signal. See onActivateLink(org.gnome.gtk.LinkButton.ActivateLinkCallback).

builder

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

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

Returns:

the builder object