Gtk.LinkButton¶

A link button is created by calling either [ctor`Gtk`.LinkButton.new] or [ctor`Gtk`.LinkButton.new_with_label]. 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 [method`Gtk`.LinkButton.set_uri].

By default, GtkLinkButton calls [method`Gtk`.FileLauncher.launch] when the button is clicked. This behaviour can be overridden by connecting to the [signal`Gtk`.LinkButton::activate-link] signal and returning True from the signal handler.

Shortcuts and Gestures

GtkLinkButton supports the following keyboard shortcuts:

<kbd>Shift</kbd>+<kbd>F10</kbd> or <kbd>Menu</kbd> 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 [enum`Gtk`.AccessibleRole.link] role.

classmethod new(uri)[source]¶

Parameters:: uri (str) – a valid URI
Returns:: a new link button widget.
Return type:: Gtk.Widget

Creates a new GtkLinkButton with the URI as its text.

classmethod new_with_label(uri, label)[source]¶

Parameters:

uri (str) – a valid URI
label (str or None) – the text of the button

Returns:

a new link button widget.

Return type:

Gtk.Widget

Creates a new GtkLinkButton containing a label.

get_uri()[source]¶

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

Retrieves the URI of the GtkLinkButton.

get_visited()[source]¶

Returns:: True if the link has been visited, False otherwise
Return type:: bool

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 [method`Gtk`.LinkButton.set_visited].

set_uri(uri)[source]¶

Parameters:: uri (str) – a valid URI

Sets uri as the URI where the GtkLinkButton points.

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

set_visited(visited)[source]¶

Parameters:: visited (bool) – the new “visited” state

Sets the “visited” state of the GtkLinkButton.

See [method`Gtk`.LinkButton.get_visited] for more details.

Signal Details¶

Gtk.LinkButton.signals.activate_link(link_button)¶

Signal Name:: activate-link
Flags:: RUN_LAST
Parameters:: link_button (Gtk.LinkButton) – The object which received the signal
Returns:: True if the signal has been handled
Return type:: bool

Emitted each time the GtkLinkButton is clicked.

The default handler will call [method`Gtk`.FileLauncher.launch] with the URI stored inside the [property`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.

Property Details¶

Gtk.LinkButton.props.uri¶

Name:: uri
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The URI bound to this button.

Gtk.LinkButton.props.visited¶

Name:: visited
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The ‘visited’ state of this button.

A visited link is drawn in a different color.