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

Constructors

LinkButton (ManagedPtr LinkButton)

Instances

GObject LinkButton

Methods

gobjectType :: LinkButton -> IO GType

IsImplementorIface LinkButton

IsObject LinkButton

IsWidget LinkButton

IsContainer LinkButton

IsButton LinkButton

IsBin LinkButton

IsBuildable LinkButton

IsActivatable LinkButton

IsActionable LinkButton

IsLinkButton LinkButton

class GObject o => IsLinkButton o

Instances

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

IsLinkButton LinkButton

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

noLinkButton :: 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

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

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

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

visited

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

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

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

Signals

activateLink

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

type LinkButtonActivateLinkCallback = IO Bool

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

genClosure_LinkButtonActivateLink :: LinkButtonActivateLinkCallback -> IO Closure

mk_LinkButtonActivateLinkCallback :: C_LinkButtonActivateLinkCallback -> IO (FunPtr C_LinkButtonActivateLinkCallback)

noLinkButtonActivateLinkCallback :: Maybe LinkButtonActivateLinkCallback

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

wrap_LinkButtonActivateLinkCallback :: LinkButtonActivateLinkCallback -> Ptr () -> Ptr () -> IO CInt