Gtk.LinkButton¶
Methods¶
| class | new (uri) |
| class | new_with_label (uri, label) |
get_uri () |
|
get_visited () |
|
set_uri (uri) |
|
set_visited (visited) |
Virtual Methods¶
| Inherited: | Gtk.Button (6), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.Actionable (4), Gtk.Activatable (2) |
|---|
do_activate_link () |
Properties¶
| Inherited: | Gtk.Button (9), Gtk.Container (3), Gtk.Widget (39), Gtk.Actionable (2), Gtk.Activatable (2) |
|---|
| Name | Type | Flags | Short Description |
|---|---|---|---|
uri |
str |
r/w | The URI bound to this button |
visited |
bool |
r/w/en | Whether this link has been visited. |
Style Properties¶
| Inherited: | Gtk.Button (7), Gtk.Widget (17) |
|---|
Signals¶
| Inherited: | Gtk.Button (6), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1) |
|---|
| Name | Short Description |
|---|---|
activate-link |
The ::activate-link signal is emitted each time the Gtk.LinkButton has been clicked. |
Fields¶
| Inherited: | Gtk.Button (6), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1) |
|---|
| Name | Type | Access | Description |
|---|---|---|---|
| parent_instance | Gtk.Button |
r |
Class Details¶
-
class
Gtk.LinkButton(*args, **kwargs)¶ Bases: Gtk.ButtonAbstract: No Structure: Gtk.LinkButtonClassA
Gtk.LinkButtonis aGtk.Buttonwith a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources.A link button is created by calling either
Gtk.LinkButton.new() orGtk.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
Gtk.LinkButtoncan be set specifically usingGtk.LinkButton.set_uri(), and retrieved usingGtk.LinkButton.get_uri().By default,
Gtk.LinkButtoncallsGtk.show_uri_on_window() when the button is clicked. This behaviour can be overridden by connecting to theGtk.LinkButton::activate-linksignal and returningTruefrom the signal handler.- CSS nodes
Gtk.LinkButtonhas a single CSS node with name button. To differentiate it from a plainGtk.Button, it gets the .link style class.-
classmethod
new(uri)[source]¶ Parameters: uri ( str) – a valid URIReturns: a new link button widget. Return type: Gtk.WidgetCreates a new
Gtk.LinkButtonwith the URI as its text.New in version 2.10.
-
classmethod
new_with_label(uri, label)[source]¶ Parameters: Returns: a new link button widget.
Return type: Creates a new
Gtk.LinkButtoncontaining a label.New in version 2.10.
-
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: strRetrieves the URI set using
Gtk.LinkButton.set_uri().New in version 2.10.
-
get_visited()[source]¶ Returns: Trueif the link has been visited,FalseotherwiseReturn type: boolRetrieves the “visited” state of the URI where the
Gtk.LinkButtonpoints. 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
Gtk.LinkButton.set_visited().New in version 2.14.
-
set_uri(uri)[source]¶ Parameters: uri ( str) – a valid URISets uri as the URI where the
Gtk.LinkButtonpoints. As a side-effect this unsets the “visited” state of the button.New in version 2.10.
-
set_visited(visited)[source]¶ Parameters: visited ( bool) – the new “visited” stateSets the “visited” state of the URI where the
Gtk.LinkButtonpoints. SeeGtk.LinkButton.get_visited() for more details.New in version 2.14.
Signal Details¶
-
Gtk.LinkButton.signals.activate_link(link_button)¶ Signal Name: activate-linkFlags: RUN_LASTParameters: link_button ( Gtk.LinkButton) – The object which received the signalReturn type: boolThe
::activate-linksignal is emitted each time theGtk.LinkButtonhas been clicked.The default handler will call
Gtk.show_uri_on_window() with the URI stored inside theGtk.LinkButton:uriproperty.To override the default behavior, you can connect to the
::activate-linksignal and stop the propagation of the signal by returningTruefrom your handler.