Glazier.React.Widget

Documentation

type family CommandOf w where ...

Equations

CommandOf (Widget c a o m p) = c

type family ActionOf w where ...

Equations

ActionOf (Widget c a o m p) = a

type family OutlineOf w where ...

Equations

OutlineOf (Widget c a o m p) = o

type family ModelOf w where ...

Equations

ModelOf (Widget c a o m p) = m

type family PlanOf w where ...

Equations

PlanOf (Widget c a o m p) = p

type SceneOf w = Scene (ModelOf w) (PlanOf w)

type FrameOf w = Frame (ModelOf w) (PlanOf w)

type GizmoOf w = Gizmo (ModelOf w) (PlanOf w)

type WindowOf w = WindowT (SceneOf w) (ReactMlT Identity) ()

type GadgetOf w = GadgetT (ActionOf w) (GizmoOf w) Identity (DList (CommandOf w))

data WithGizmo

tag used to choose Schema that contains Gizmos

data WithOutline

tag used to choose Schema that contains Outlines

type family SchemaType tag w where ...

You can't use type family as a type variable for a data type. The workaround is to use a tag to choose between different type family functions. ModelType takes a tag to choose between Gizmo or Outline. This enables creating a data type that can specialize to using the tag.

Equations

SchemaType WithGizmo w = GizmoOf w

SchemaType WithOutline w = OutlineOf w

data Widget c a o m p where

Record of functions for a widget. Contains everything you need to make the model, render, and run the event processing. This is a GADT to enforce the Disposing and ToOutline constraints at the time of creating the Widget record.

Constructors

Widget :: (Disposing m, Disposing p, ToOutline m o) => (o -> F (Maker a) m) -> (Frame m p -> F (Maker a) p) -> WindowT (Scene m p) (ReactMlT Identity) () -> GadgetT a (Gizmo m p) Identity (DList c) -> Widget c a o m p

Instances

(Disposing m, Disposing p, ToOutline m o) => IsWidget (Widget c a o m p)

Methods

mkModel :: Widget c a o m p -> OutlineOf (Widget c a o m p) -> F (Maker (ActionOf (Widget c a o m p))) (ModelOf (Widget c a o m p))

mkPlan :: Widget c a o m p -> Frame (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p)) -> F (Maker (ActionOf (Widget c a o m p))) (PlanOf (Widget c a o m p))

window :: Widget c a o m p -> WindowT (Scene (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p))) (ReactMlT Identity) ()

gadget :: Widget c a o m p -> GadgetT (ActionOf (Widget c a o m p)) (Gizmo (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p))) Identity (DList (CommandOf (Widget c a o m p)))

class (Disposing (ModelOf w), Disposing (PlanOf w), ToOutline (ModelOf w) (OutlineOf w)) => IsWidget w where

This typeclass is convenient as it carries the 'Disposing Model' and 'Disposing Plan' constraints and allows treating 'Widget c a m p' as a type w

Minimal complete definition

mkModel, mkPlan, window, gadget

Methods

mkModel :: w -> OutlineOf w -> F (Maker (ActionOf w)) (ModelOf w)

Make a Model from an Outline

mkPlan :: w -> Frame (ModelOf w) (PlanOf w) -> F (Maker (ActionOf w)) (PlanOf w)

Given an empty frame, make the Plan that uses the frame for rendering

window :: w -> WindowT (Scene (ModelOf w) (PlanOf w)) (ReactMlT Identity) ()

Rendering function that uses the Scene of Model and Plan

gadget :: w -> GadgetT (ActionOf w) (Gizmo (ModelOf w) (PlanOf w)) Identity (DList (CommandOf w))

Update function that processes Action to update the Frame and Scene

Instances

(Disposing m, Disposing p, ToOutline m o) => IsWidget (Widget c a o m p)

Methods

mkModel :: Widget c a o m p -> OutlineOf (Widget c a o m p) -> F (Maker (ActionOf (Widget c a o m p))) (ModelOf (Widget c a o m p))

mkPlan :: Widget c a o m p -> Frame (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p)) -> F (Maker (ActionOf (Widget c a o m p))) (PlanOf (Widget c a o m p))

window :: Widget c a o m p -> WindowT (Scene (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p))) (ReactMlT Identity) ()

gadget :: Widget c a o m p -> GadgetT (ActionOf (Widget c a o m p)) (Gizmo (ModelOf (Widget c a o m p)) (PlanOf (Widget c a o m p))) Identity (DList (CommandOf (Widget c a o m p)))

mkGizmo :: IsWidget w => w -> ModelOf w -> F (Maker (ActionOf w)) (Gizmo (ModelOf w) (PlanOf w))

Make the required Frame and Plan for a Model

mkGizmo' :: IsWidget w => w -> OutlineOf w -> F (Maker (ActionOf w)) (Gizmo (ModelOf w) (PlanOf w))

Make the required Frame and Plan from an Outline