Graphics.UI.Gtk.Buttons.LinkButton

gtk3-0.14.6: Binding to the Gtk+ 3 graphical user interface library

Maintainer | gtk2hs-users@lists.sourceforge.net
Stability | provisional
Portability | portable (depends on GHC)
Safe Haskell | None
Language | Haskell98

Graphics.UI.Gtk.Buttons.LinkButton

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Attributes

Description

Create buttons bound to a URL

- Module available since Gtk+ version 2.10

Synopsis

- data LinkButton
- class ButtonClass o => LinkButtonClass o
- castToLinkButton :: GObjectClass obj => obj -> LinkButton
- toLinkButton :: LinkButtonClass o => o -> LinkButton
- linkButtonNew :: GlibString string => string -> IO LinkButton
- linkButtonNewWithLabel :: GlibString string => string -> string -> IO LinkButton
- linkButtonURI :: (LinkButtonClass self, GlibString string) => Attr self string
- linkButtonVisited :: LinkButtonClass self => Attr self Bool

# Detail

A `LinkButton` 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 `LinkButton` can be set specifically using "set linkButton [linkButtonURI := uri]", and retrieved using "uri <- get linkButton linkButtonURI".

`LinkButton` offers a global hook, which is called when the used clicks on it: see `linkButtonSetURIHook`.

`LinkButton` was added in Gtk+ 2.10.

# Class Hierarchy

    | GObject
    | +----Object
    | +----Widget
    | +----Container
    | +----Bin
    | +----Button
    | +----LinkButton

# Types

data LinkButton #

Instances

Eq LinkButton # |
Methods (==) :: LinkButton -> LinkButton -> Bool # (/=) :: LinkButton -> LinkButton -> Bool #
Ord LinkButton # |
Methods compare :: LinkButton -> LinkButton -> Ordering # (<) :: LinkButton -> LinkButton -> Bool # (<=) :: LinkButton -> LinkButton -> Bool # (>) :: LinkButton -> LinkButton -> Bool # (>=) :: LinkButton -> LinkButton -> Bool # max :: LinkButton -> LinkButton -> LinkButton # min :: LinkButton -> LinkButton -> LinkButton #
GObjectClass LinkButton # |
Methods toGObject :: LinkButton -> GObject # unsafeCastGObject :: GObject -> LinkButton #
LinkButtonClass LinkButton # |
ButtonClass LinkButton # |
BinClass LinkButton # |
ContainerClass LinkButton # |
WidgetClass LinkButton # |

class ButtonClass o => LinkButtonClass o #

Instances

LinkButtonClass LinkButton # |

castToLinkButton :: GObjectClass obj => obj -> LinkButton #

toLinkButton :: LinkButtonClass o => o -> LinkButton #

# Constructors

linkButtonNew #

Arguments

:: GlibString string |
=> string | `uri` - a valid URI
-> IO LinkButton |

Creates a new `LinkButton` with the URI as its text.

linkButtonNewWithLabel #

Arguments

:: GlibString string |
=> string | `uri` - a valid URI
-> string | `label` - the text of the button
-> IO LinkButton |

Creates a new `LinkButton` containing a label.

# Methods

# Attributes

linkButtonURI :: (LinkButtonClass self, GlibString string) => Attr self string #

The URI bound to this button.

Default value: ""

- Available since Gtk+ version 2.10

linkButtonVisited :: LinkButtonClass self => Attr self Bool #

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

Default value: `False`

- Available since Gtk+ version 2.14