Graphics.UI.Threepenny.Editors.Types

Editors

data Editor editorElement a

A widget for editing values of type a.

Constructors

Editor

Fields

• _editorTidings :: Tidings a
• _editorElement :: editorElement

Instances

Bifunctor Editor

Methods

bimap :: (a -> b) -> (c -> d) -> Editor a c -> Editor b d

first :: (a -> b) -> Editor a c -> Editor b c

second :: (b -> c) -> Editor a b -> Editor a c

Functor (Editor editorElement)

Methods

fmap :: (a -> b) -> Editor editorElement a -> Editor editorElement b

(<$) :: a -> Editor editorElement b -> Editor editorElement a

Widget el => Widget (Editor el a)

Methods

getElement :: Editor el a -> Element

edited :: Editor el a -> Event a

contents :: Editor el a -> Behavior a

editorElement :: Lens (Editor el a) (Editor el' a) el el'

A lens over the editorElement field

newtype EditorFactory a el b

A function from Behavior a to Editor b All the three type arguments are functorial, but a is contravariant. EditorFactory is a Biapplicative functor on el and b, and a Profunctor on a and b.

Constructors

EF

Fields

• runEF :: Behavior a -> UI (Editor el b)

Instances

Bifunctor (EditorFactory a)

Methods

bimap :: (a -> b) -> (c -> d) -> EditorFactory a a c -> EditorFactory a b d

first :: (a -> b) -> EditorFactory a a c -> EditorFactory a b c

second :: (b -> c) -> EditorFactory a a b -> EditorFactory a a c

Biapplicative (EditorFactory a)

Methods

bipure :: a -> b -> EditorFactory a a b

(<<*>>) :: EditorFactory a (a -> b) (c -> d) -> EditorFactory a a c -> EditorFactory a b d

(*>>) :: EditorFactory a a b -> EditorFactory a c d -> EditorFactory a c d

(<<*) :: EditorFactory a a b -> EditorFactory a c d -> EditorFactory a a b

Functor (EditorFactory a el)

Methods

fmap :: (a -> b) -> EditorFactory a el a -> EditorFactory a el b

(<$) :: a -> EditorFactory a el b -> EditorFactory a el a

Monoid el => Applicative (EditorFactory a el)

Methods

pure :: a -> EditorFactory a el a

(<*>) :: EditorFactory a el (a -> b) -> EditorFactory a el a -> EditorFactory a el b

(*>) :: EditorFactory a el a -> EditorFactory a el b -> EditorFactory a el b

(<*) :: EditorFactory a el a -> EditorFactory a el b -> EditorFactory a el a

dimapEF :: (a' -> a) -> (b -> b') -> EditorFactory a el b -> EditorFactory a' el b'

lmapEF :: (a' -> a) -> EditorFactory a el b -> EditorFactory a' el b

Applies a function over the input

applyEF :: (el1 -> el2 -> el) -> EditorFactory in_ el1 (a -> b) -> EditorFactory in_ el2 a -> EditorFactory in_ el b

createEditor :: Renderable w => EditorFactory a w b -> Behavior a -> UI (Editor Element b)

Create an editor to display the argument. User edits are fed back via the edited Event.

renderEditor :: Renderable w => Editor w a -> UI (Editor Element a)

editorFactoryElement :: Setter (EditorFactory a el b) (EditorFactory a el' b) el el'

A Setter over the element of the editor being built

editorFactoryInput :: Setter (EditorFactory a el b) (EditorFactory a' el b) a' a

A Setter over the input thing

editorFactoryOutput :: Setter (EditorFactory a el b) (EditorFactory a el b') b b'

A Setter over the output thing

Editor composition

(|*|) :: EditorFactory s Layout (b -> a) -> EditorFactory s Layout b -> EditorFactory s Layout a infixl 4

Left-right editor composition

(|*) :: EditorFactory s Layout a -> UI Element -> EditorFactory s Layout a infixl 5

Left-right composition of an editorElement with a editor

(*|) :: UI Element -> EditorFactory s Layout a -> EditorFactory s Layout a infixl 5

Left-right composition of an editorElement with a editor

(-*-) :: EditorFactory s Layout (b -> a) -> EditorFactory s Layout b -> EditorFactory s Layout a infixl 4

Left-right editor composition

(-*) :: EditorFactory s Layout a -> UI Element -> EditorFactory s Layout a infixl 5

Left-right composition of an editorElement with a editor

(*-) :: UI Element -> EditorFactory s Layout a -> EditorFactory s Layout a infixl 5

Left-right composition of an editorElement with a editor

field :: Renderable m => String -> (out -> inn) -> EditorFactory inn m a -> EditorFactory out Layout a

A helper that arranges a label with the field name and the editor horizontally.

fieldLayout :: (Renderable m, Renderable m') => (Layout -> m') -> String -> (out -> inn) -> EditorFactory inn m a -> EditorFactory out m' a

A helper that arranges a label with the field name and the editor horizontally. This version takes a Layout builder as well.

edit :: (a' -> a) -> EditorFactory a el b -> EditorFactory a' el b

Focus the editor on the field retrieved by the getter. Use when composing editors via the Biapplicative interface

personEditor :: EditorFactory Person PersonEditor Person
personEditor =
    bipure Person Person
      <<*>> edit education editor
      <<*>> edit firstName editor
      <<*>> edit lastName  editor

pattern Horizontally :: forall a b. EditorFactory a Layout b -> EditorFactory a Horizontal b

Applicative modifier for horizontal composition of editor factories. This can be used in conjunction with ApplicativeDo as:

editorPerson = horizontally $ do
      firstName <- Horizontally $ field "First:" firstName editor
      lastName  <- Horizontally $ field "Last:"  lastName editor
      age       <- Horizontally $ field "Age:"   age editor
      return Person{..}

DEPRECATED: Use the Horizontal layout builder instead

pattern Vertically :: forall a b. EditorFactory a Layout b -> EditorFactory a Vertical b

Applicative modifier for vertical composition of editor factories. This can be used in conjunction with ApplicativeDo as:

editorPerson = vertically $ do
      firstName <- Vertically $ field "First:" firstName editor
      lastName  <- Vertically $ field "Last:"  lastName editor
      age       <- Vertically $ field "Age:"   age editor
      return Person{..}

DEPRECATED: Use the Vertical layout builder instead

Editor constructors

editorUnit :: EditorFactory b Element b

editorIdentity :: EditorFactory a el a -> EditorFactory (Identity a) el (Identity a)

editorString :: EditorFactory String TextEntry String

editorCheckBox :: EditorFactory Bool Element Bool

editorReadShow :: (Read a, Show a) => EditorFactory (Maybe a) TextEntry (Maybe a)

editorEnumBounded :: (Bounded a, Enum a, Ord a, Show a) => Behavior (a -> UI Element) -> EditorFactory (Maybe a) (ListBox a) (Maybe a)

editorSelection :: Ord a => Behavior [a] -> Behavior (a -> UI Element) -> EditorFactory (Maybe a) (ListBox a) (Maybe a)

An editor that presents a dynamic choice of values.

editorSum :: (Ord tag, Show tag, Renderable el) => (Layout -> Layout -> Layout) -> [(tag, EditorFactory a el a)] -> (a -> tag) -> EditorFactory a Layout a

An editor for union types, built from editors for its constructors.

editorJust :: EditorFactory (Maybe b) el (Maybe b) -> EditorFactory b el b

Ignores Nothing values and only updates for Just values

Editor layout

withLayout :: (layout -> layout') -> EditorFactory a layout b -> EditorFactory a layout' b

Apply a layout builder.

construct :: Renderable m => EditorFactory a m b -> EditorFactory a Layout b

Construct a concrete Layout. Useful when combining heterogeneours layout builders.