GI.Gtk.Declarative.Markup

MarkupOf is the common builder type for the (declarative) GTK+ markup language, supporting do syntax. MarkupOf wraps many widgets, usually of type Widget, but they can be of other types.

A Widget value can wrap any Patchable widget, hiding the underlying widget type, such that you can embed heterogeneous collections of widgets in containers.

Documentation

data Widget event where

A Widget value wraps a Patchable and EventSource widget, providing a constrained equivalent of a Dynamic value. It is used to support heterogeneous containers of widgets, and to support equality checks on different types of widgets when calculating patches.

Constructors

Widget :: (Typeable widget, Patchable widget, Functor widget, EventSource widget) => widget event -> Widget event

Instances

Functor Widget

Defined in GI.Gtk.Declarative.Markup

Methods

fmap :: (a -> b) -> Widget a -> Widget b

(<$) :: a -> Widget b -> Widget a

Patchable Widget

Widget is itself patchable, by delegating to the underlying widget instances.

Defined in GI.Gtk.Declarative.Markup

Methods

create :: Widget e -> IO SomeState

patch :: SomeState -> Widget e1 -> Widget e2 -> Patch

EventSource Widget

Defined in GI.Gtk.Declarative.Markup

Methods

subscribe :: Widget event -> SomeState -> (event -> IO ()) -> IO Subscription

BinChild Dialog Widget

Defined in GI.Gtk.Declarative.Bin

BinChild ListBoxRow Widget

Defined in GI.Gtk.Declarative.Bin

BinChild MenuItem Widget

Defined in GI.Gtk.Declarative.Bin

BinChild ScrolledWindow Widget

Defined in GI.Gtk.Declarative.Bin

BinChild Window Widget

Defined in GI.Gtk.Declarative.Bin

FromWidget Widget event (Widget event)

Defined in GI.Gtk.Declarative.Markup

Methods

fromWidget :: Widget event -> Widget event

IsContainer ListBox (Bin ListBoxRow Widget)

Defined in GI.Gtk.Declarative.Container.Patch

Methods

appendChild :: ListBox -> Bin ListBoxRow Widget event -> Widget0 -> IO ()

replaceChild :: ListBox -> Bin ListBoxRow Widget event -> Int32 -> Widget0 -> Widget0 -> IO ()

(Typeable widget, Functor (SingleWidget widget)) => FromWidget (SingleWidget widget) event (Widget event)

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> Widget event

(Typeable widget, Functor (SingleWidget widget)) => FromWidget (SingleWidget widget) event (Markup event ())

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> Markup event ()

(BinChild widget child, Typeable widget, Patchable child, EventSource child, Functor (Bin widget child)) => FromWidget (Bin widget child) event (Widget event)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Widget event

(Typeable widget, Typeable children, Patchable (Container widget children), EventSource (Container widget children), Functor (Container widget children)) => FromWidget (Container widget children) event (Widget event)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Widget event

(BinChild widget child, a ~ (), Typeable widget, Patchable child, EventSource child, Functor (Bin widget child)) => FromWidget (Bin widget child) event (Markup event a)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Markup event a

(a ~ (), Typeable widget, Typeable children, Patchable (Container widget children), EventSource (Container widget children), Functor (Container widget children)) => FromWidget (Container widget children) event (Markup event a)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Markup event a

Markup

data MarkupOf widget event a

The declarative markup builder, primarily for using its Monad instance and do notation to construct adjacent widgets in containers.

It is parameterized with widget and event, such that containers can restrict the type of their children to other types than Widget.

Note that the return type, a, is not used in this library. It's a more a technical necessity to have the Monad instance. You can still use it if you need to return a value from a markup function, though.

Instances

(Typeable widget, Functor (SingleWidget widget)) => FromWidget (SingleWidget widget) event (Markup event ())

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> Markup event ()

FromWidget (SingleWidget widget) event (MarkupOf (SingleWidget widget) event ())

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> MarkupOf (SingleWidget widget) event ()

Monad (MarkupOf widget event)

Defined in GI.Gtk.Declarative.Markup

Methods

(>>=) :: MarkupOf widget event a -> (a -> MarkupOf widget event b) -> MarkupOf widget event b

(>>) :: MarkupOf widget event a -> MarkupOf widget event b -> MarkupOf widget event b

return :: a -> MarkupOf widget event a

fail :: String -> MarkupOf widget event a

Functor (MarkupOf widget event)

Defined in GI.Gtk.Declarative.Markup

Methods

fmap :: (a -> b) -> MarkupOf widget event a -> MarkupOf widget event b

(<$) :: a -> MarkupOf widget event b -> MarkupOf widget event a

Applicative (MarkupOf widget event)

Defined in GI.Gtk.Declarative.Markup

Methods

pure :: a -> MarkupOf widget event a

(<*>) :: MarkupOf widget event (a -> b) -> MarkupOf widget event a -> MarkupOf widget event b

liftA2 :: (a -> b -> c) -> MarkupOf widget event a -> MarkupOf widget event b -> MarkupOf widget event c

(*>) :: MarkupOf widget event a -> MarkupOf widget event b -> MarkupOf widget event b

(<*) :: MarkupOf widget event a -> MarkupOf widget event b -> MarkupOf widget event a

(BinChild widget child, a ~ (), Typeable widget, Patchable child, EventSource child, Functor (Bin widget child)) => FromWidget (Bin widget child) event (Markup event a)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Markup event a

(a ~ (), Typeable widget, Typeable children, Patchable (Container widget children), EventSource (Container widget children), Functor (Container widget children)) => FromWidget (Container widget children) event (Markup event a)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Markup event a

a ~ () => FromWidget (Bin widget child) event (MarkupOf (Bin widget child) event a)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> MarkupOf (Bin widget child) event a

a ~ () => FromWidget (Container widget children) event (MarkupOf (Container widget children) event a)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> MarkupOf (Container widget children) event a

type Markup event a = MarkupOf Widget event a

Handy type alias for the common case of markup containing Widgets.

single :: widget event -> MarkupOf widget event ()

Construct markup from a single widget.

multiple :: Vector (widget event) -> MarkupOf widget event ()

Construct markup from multiple widgets.

runMarkup :: MarkupOf widget event () -> Vector (widget event)

Run a MarkupOf builder and get its widgets.

Widget to Markup conversion

class FromWidget widget event target | target -> event where

Convert a widget to a target type. This is deliberately unconstrained in it's types, and is used by smart constructors to implement return type polymorphism, so that a smart contructor can return either a Widget, or some specifically typed MarkupOf, depending on the context in which it's used.

Minimal complete definition

fromWidget

Methods

fromWidget :: (Typeable widget, Typeable event) => widget event -> target

Instances

FromWidget Widget event (Widget event)

Defined in GI.Gtk.Declarative.Markup

Methods

fromWidget :: Widget event -> Widget event

(Typeable widget, Functor (SingleWidget widget)) => FromWidget (SingleWidget widget) event (Widget event)

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> Widget event

(Typeable widget, Functor (SingleWidget widget)) => FromWidget (SingleWidget widget) event (Markup event ())

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> Markup event ()

FromWidget (SingleWidget widget) event (MarkupOf (SingleWidget widget) event ())

Defined in GI.Gtk.Declarative.SingleWidget

Methods

fromWidget :: SingleWidget widget event -> MarkupOf (SingleWidget widget) event ()

(BinChild widget child, Typeable widget, Patchable child, EventSource child, Functor (Bin widget child)) => FromWidget (Bin widget child) event (Widget event)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Widget event

(Typeable widget, Typeable children, Patchable (Container widget children), EventSource (Container widget children), Functor (Container widget children)) => FromWidget (Container widget children) event (Widget event)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Widget event

(BinChild widget child, a ~ (), Typeable widget, Patchable child, EventSource child, Functor (Bin widget child)) => FromWidget (Bin widget child) event (Markup event a)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Markup event a

(a ~ (), Typeable widget, Typeable children, Patchable (Container widget children), EventSource (Container widget children), Functor (Container widget children)) => FromWidget (Container widget children) event (Markup event a)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Markup event a

FromWidget (Bin widget child) event (Bin widget child event)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> Bin widget child event

a ~ () => FromWidget (Bin widget child) event (MarkupOf (Bin widget child) event a)

Defined in GI.Gtk.Declarative.Bin

Methods

fromWidget :: Bin widget child event -> MarkupOf (Bin widget child) event a

FromWidget (Container widget children) event (Container widget children event)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> Container widget children event

a ~ () => FromWidget (Container widget children) event (MarkupOf (Container widget children) event a)

Defined in GI.Gtk.Declarative.Container

Methods

fromWidget :: Container widget children event -> MarkupOf (Container widget children) event a