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

((~) * info (ResolveLinkButtonMethod t LinkButton), MethodInfo * info LinkButton p) => IsLabel t (LinkButton -> p)

Methods

fromLabel :: Proxy# Symbol t -> LinkButton -> p

((~) * info (ResolveLinkButtonMethod t LinkButton), MethodInfo * info LinkButton p) => IsLabelProxy t (LinkButton -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> LinkButton -> p

HasAttributeList * LinkButton

type AttributeList LinkButton

type AttributeList LinkButton

type SignalList LinkButton

type SignalList LinkButton

class GObject o => IsLinkButton o

Instances

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

IsLinkButton LinkButton

toLinkButton :: IsLinkButton o => o -> IO LinkButton

noLinkButton :: Maybe LinkButton

Methods

getUri

data LinkButtonGetUriMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsLinkButton a) => MethodInfo * LinkButtonGetUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LinkButtonGetUriMethodInfo a -> signature -> s

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

data LinkButtonGetVisitedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsLinkButton a) => MethodInfo * LinkButtonGetVisitedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LinkButtonGetVisitedMethodInfo a -> signature -> s

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

data LinkButtonSetUriMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsLinkButton a) => MethodInfo * LinkButtonSetUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LinkButtonSetUriMethodInfo a -> signature -> s

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

data LinkButtonSetVisitedMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsLinkButton a) => MethodInfo * LinkButtonSetVisitedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy LinkButtonSetVisitedMethodInfo a -> signature -> s

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

data LinkButtonUriPropertyInfo

Instances

AttrInfo LinkButtonUriPropertyInfo

Associated Types

type AttrAllowedOps LinkButtonUriPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LinkButtonUriPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LinkButtonUriPropertyInfo :: * -> Constraint

type AttrGetType LinkButtonUriPropertyInfo :: *

type AttrLabel LinkButtonUriPropertyInfo :: Symbol

type AttrOrigin LinkButtonUriPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LinkButtonUriPropertyInfo o => Proxy * LinkButtonUriPropertyInfo -> o -> IO (AttrGetType LinkButtonUriPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LinkButtonUriPropertyInfo o, AttrSetTypeConstraint LinkButtonUriPropertyInfo b) => Proxy * LinkButtonUriPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LinkButtonUriPropertyInfo o => Proxy * LinkButtonUriPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LinkButtonUriPropertyInfo o, AttrSetTypeConstraint LinkButtonUriPropertyInfo b) => Proxy * LinkButtonUriPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LinkButtonUriPropertyInfo

type AttrOrigin LinkButtonUriPropertyInfo = LinkButton

type AttrLabel LinkButtonUriPropertyInfo

type AttrLabel LinkButtonUriPropertyInfo = "uri"

type AttrGetType LinkButtonUriPropertyInfo

type AttrGetType LinkButtonUriPropertyInfo = Text

type AttrBaseTypeConstraint LinkButtonUriPropertyInfo

type AttrBaseTypeConstraint LinkButtonUriPropertyInfo = IsLinkButton

type AttrSetTypeConstraint LinkButtonUriPropertyInfo

type AttrSetTypeConstraint LinkButtonUriPropertyInfo = * ~ Text

type AttrAllowedOps LinkButtonUriPropertyInfo

type AttrAllowedOps LinkButtonUriPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

linkButtonUri :: AttrLabelProxy "uri"

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

visited

data LinkButtonVisitedPropertyInfo

Instances

AttrInfo LinkButtonVisitedPropertyInfo

Associated Types

type AttrAllowedOps LinkButtonVisitedPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint LinkButtonVisitedPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo :: * -> Constraint

type AttrGetType LinkButtonVisitedPropertyInfo :: *

type AttrLabel LinkButtonVisitedPropertyInfo :: Symbol

type AttrOrigin LinkButtonVisitedPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo o => Proxy * LinkButtonVisitedPropertyInfo -> o -> IO (AttrGetType LinkButtonVisitedPropertyInfo)

attrSet :: (AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo o, AttrSetTypeConstraint LinkButtonVisitedPropertyInfo b) => Proxy * LinkButtonVisitedPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo o => Proxy * LinkButtonVisitedPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo o, AttrSetTypeConstraint LinkButtonVisitedPropertyInfo b) => Proxy * LinkButtonVisitedPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin LinkButtonVisitedPropertyInfo

type AttrOrigin LinkButtonVisitedPropertyInfo = LinkButton

type AttrLabel LinkButtonVisitedPropertyInfo

type AttrLabel LinkButtonVisitedPropertyInfo = "visited"

type AttrGetType LinkButtonVisitedPropertyInfo

type AttrGetType LinkButtonVisitedPropertyInfo = Bool

type AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo

type AttrBaseTypeConstraint LinkButtonVisitedPropertyInfo = IsLinkButton

type AttrSetTypeConstraint LinkButtonVisitedPropertyInfo

type AttrSetTypeConstraint LinkButtonVisitedPropertyInfo = * ~ Bool

type AttrAllowedOps LinkButtonVisitedPropertyInfo

type AttrAllowedOps LinkButtonVisitedPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

linkButtonVisited :: AttrLabelProxy "visited"

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

Signals

activateLink

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

type LinkButtonActivateLinkCallback = IO Bool

data LinkButtonActivateLinkSignalInfo

Instances

SignalInfo LinkButtonActivateLinkSignalInfo

Associated Types

type HaskellCallbackType LinkButtonActivateLinkSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o LinkButtonActivateLinkSignalInfo -> o -> HaskellCallbackType LinkButtonActivateLinkSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType LinkButtonActivateLinkSignalInfo

type HaskellCallbackType LinkButtonActivateLinkSignalInfo = LinkButtonActivateLinkCallback

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

genClosure_LinkButtonActivateLink :: LinkButtonActivateLinkCallback -> IO Closure

mk_LinkButtonActivateLinkCallback :: C_LinkButtonActivateLinkCallback -> IO (FunPtr C_LinkButtonActivateLinkCallback)

noLinkButtonActivateLinkCallback :: Maybe LinkButtonActivateLinkCallback

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

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