GI.Gtk.Objects.LinkButton

A GtkLinkButton is a Button with 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 linkButtonNew or linkButtonNewWithLabel. 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 linkButtonSetUri, and retrieved using linkButtonGetUri.

By default, GtkLinkButton calls showUriOnWindow when the button is clicked. This behaviour can be overridden by connecting to the LinkButton::activate-link signal and returning True from the signal handler.

CSS nodes

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

Exported types

newtype LinkButton

Memory-managed wrapper type.

Constructors

LinkButton (ManagedPtr LinkButton)

Instances

GObject LinkButton

Defined in GI.Gtk.Objects.LinkButton

Methods

gobjectType :: LinkButton -> IO GType

IsImplementorIface LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsObject LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsActionable LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsActivatable LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsBuildable LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsBin LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsButton LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsContainer LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsWidget LinkButton

Defined in GI.Gtk.Objects.LinkButton

IsLinkButton LinkButton

Defined in GI.Gtk.Objects.LinkButton

class GObject o => IsLinkButton o

Type class for types which can be safely cast to LinkButton, for instance with toLinkButton.

Instances

(GObject a, (UnknownAncestorError LinkButton a :: Constraint)) => IsLinkButton a

Defined in GI.Gtk.Objects.LinkButton

IsLinkButton LinkButton

Defined in GI.Gtk.Objects.LinkButton

toLinkButton :: (MonadIO m, IsLinkButton o) => o -> m LinkButton

Cast to LinkButton, for types for which this is known to be safe. For general casts, use castTo.

noLinkButton :: Maybe LinkButton

A convenience alias for Nothing :: Maybe LinkButton.

Methods

getUri

linkButtonGetUri

Arguments

:: (HasCallStack, MonadIO m, IsLinkButton a)

=> a

linkButton: a LinkButton

-> m Text

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

Retrieves the URI set using linkButtonSetUri.

Since: 2.10

getVisited

linkButtonGetVisited

Arguments

:: (HasCallStack, MonadIO m, IsLinkButton a)

=> a

linkButton: a LinkButton

-> m Bool

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

Retrieves the “visited” state of the URI where the LinkButton points. 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 linkButtonSetVisited.

Since: 2.14

new

linkButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

uri: a valid URI

-> m LinkButton

Returns: a new link button widget.

Creates a new LinkButton with the URI as its text.

Since: 2.10

newWithLabel

linkButtonNewWithLabel

Arguments

:: (HasCallStack, MonadIO m)

=> Text

uri: a valid URI

-> Maybe Text

label: the text of the button

-> m LinkButton

Returns: a new link button widget.

Creates a new LinkButton containing a label.

Since: 2.10

setUri

linkButtonSetUri

Arguments

:: (HasCallStack, MonadIO m, IsLinkButton a)

=> a

linkButton: a LinkButton

-> Text

uri: a valid URI

-> m ()

Sets uri as the URI where the LinkButton points. As a side-effect this unsets the “visited” state of the button.

Since: 2.10

setVisited

linkButtonSetVisited

Arguments

:: (HasCallStack, MonadIO m, IsLinkButton a)

=> a

linkButton: a LinkButton

-> Bool

visited: the new “visited” state

-> m ()

Sets the “visited” state of the URI where the LinkButton points. See linkButtonGetVisited for more details.

Since: 2.14

Properties

uri

The URI bound to this button.

Since: 2.10

constructLinkButtonUri :: IsLinkButton o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “uri” property. This is rarely needed directly, but it is used by new.

getLinkButtonUri :: (MonadIO m, IsLinkButton o) => o -> m Text

Get the value of the “uri” property. When overloading is enabled, this is equivalent to

get linkButton #uri

setLinkButtonUri :: (MonadIO m, IsLinkButton o) => o -> Text -> m ()

Set the value of the “uri” property. When overloading is enabled, this is equivalent to

set linkButton [ #uri := value ]

visited

The 'visited' state of this button. A visited link is drawn in a different color.

Since: 2.14

constructLinkButtonVisited :: IsLinkButton o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “visited” property. This is rarely needed directly, but it is used by new.

getLinkButtonVisited :: (MonadIO m, IsLinkButton o) => o -> m Bool

Get the value of the “visited” property. When overloading is enabled, this is equivalent to

get linkButton #visited

setLinkButtonVisited :: (MonadIO m, IsLinkButton o) => o -> Bool -> m ()

Set the value of the “visited” property. When overloading is enabled, this is equivalent to

set linkButton [ #visited := value ]

Signals

activateLink

type C_LinkButtonActivateLinkCallback = Ptr () -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type LinkButtonActivateLinkCallback = IO Bool

The ::activate-link signal is emitted each time the LinkButton has been clicked.

The default handler will call showUriOnWindow with the URI stored inside the 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.

afterLinkButtonActivateLink :: (IsLinkButton a, MonadIO m) => a -> LinkButtonActivateLinkCallback -> m SignalHandlerId

Connect a signal handler for the “activate-link” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after linkButton #activateLink callback

genClosure_LinkButtonActivateLink :: LinkButtonActivateLinkCallback -> IO Closure

Wrap the callback into a Closure.

mk_LinkButtonActivateLinkCallback :: C_LinkButtonActivateLinkCallback -> IO (FunPtr C_LinkButtonActivateLinkCallback)

Generate a function pointer callable from C code, from a C_LinkButtonActivateLinkCallback.

noLinkButtonActivateLinkCallback :: Maybe LinkButtonActivateLinkCallback

A convenience synonym for Nothing :: Maybe LinkButtonActivateLinkCallback.

onLinkButtonActivateLink :: (IsLinkButton a, MonadIO m) => a -> LinkButtonActivateLinkCallback -> m SignalHandlerId

Connect a signal handler for the “activate-link” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on linkButton #activateLink callback

wrap_LinkButtonActivateLinkCallback :: LinkButtonActivateLinkCallback -> C_LinkButtonActivateLinkCallback

Wrap a LinkButtonActivateLinkCallback into a C_LinkButtonActivateLinkCallback.