Safe Haskell	None
Language	Haskell2010

Graphics.UI.Threepenny.Editors.Types

Contents

GenericWidgets
Editors

Synopsis

data GenericWidget control a = GenericWidget {
- widgetTidings :: Tidings a
- widgetControl :: control
}
edited :: GenericWidget el a -> Event a
contents :: GenericWidget el a -> Behavior a
widgetControl :: GenericWidget control a -> control
widgetTidings :: GenericWidget control a -> Tidings a
newtype Editor outer widget inner where
- Editor {
  - create :: Behavior outer -> UI (GenericWidget widget inner)
  }
- pattern Horizontally :: Editor a Layout b -> Editor a Horizontal b
- pattern Vertically :: Editor a Layout b -> Editor a Vertical b
liftElement :: UI el -> Editor a el ()
dimapE :: (a' -> a) -> (b -> b') -> Editor a el b -> Editor a' el b'
applyE :: (el1 -> el2 -> el) -> Editor in_ el1 (a -> b) -> Editor in_ el2 a -> Editor in_ el b
(|*|) :: Editor s Layout (b -> a) -> Editor s Layout b -> Editor s Layout a
(|*) :: Editor s Layout a -> UI Element -> Editor s Layout a
(*|) :: UI Element -> Editor s Layout a -> Editor s Layout a
(-*-) :: Editor s Layout (b -> a) -> Editor s Layout b -> Editor s Layout a
(-*) :: Editor s Layout a -> UI Element -> Editor s Layout a
(*-) :: UI Element -> Editor s Layout a -> Editor s Layout a
field :: Renderable m => String -> (out -> inn) -> Editor inn m a -> Editor out Layout a
fieldLayout :: (Renderable m, Renderable m') => (Layout -> m') -> String -> (out -> inn) -> Editor inn m a -> Editor out m' a
editorUnit :: Editor b Element b
editorIdentity :: Editor a el a -> Editor (Identity a) el (Identity a)
editorString :: Editor String TextEntry String
editorText :: Editor Text TextEntry Text
editorCheckBox :: Editor Bool Element Bool
editorReadShow :: (Read a, Show a) => Editor (Maybe a) TextEntry (Maybe a)
editorEnumBounded :: (Bounded a, Enum a, Ord a, Show a) => Behavior (a -> UI Element) -> Editor (Maybe a) (ListBox a) (Maybe a)
editorSelection :: Ord a => Behavior [a] -> Behavior (a -> UI Element) -> Editor (Maybe a) (ListBox a) (Maybe a)
editorSum :: (Ord tag, Show tag, Renderable el) => (Layout -> Layout -> Layout) -> [(tag, Editor a el a)] -> (a -> tag) -> Editor a Layout a
editorJust :: Editor (Maybe b) el (Maybe b) -> Editor b el b
data EditorCollection k w = EditorCollection {
- selector :: ListBox k
- add, remove :: Element
- selected :: w
}
editorCollection :: forall k v w. (Ord k, Renderable w) => (Behavior (Maybe k, Map k v) -> EditorCollectionConfig k v) -> Editor v w v -> Editor (Maybe k, Map k v) (EditorCollection k w) (Maybe k, Map k v)
editorList :: (HasEmpty a, Renderable w) => Editor a w a -> Editor (Maybe Int, [a]) (EditorCollection Int w) (Maybe Int, [a])
data EditorCollectionConfig k v = EditorCollectionConfig {
- eccNewKey :: Behavior k
- eccAfterDelKey :: Behavior (Maybe k)
- eccTemplate :: v
- eccOptions :: Behavior (Set k)
- eccDisplay :: Behavior (k -> UI Element)
}
defaultEditorCollectionConfig :: (Enum k, Ord k, Show k, HasEmpty v) => Behavior (Maybe k, Map k v) -> EditorCollectionConfig k v
class HasEmpty a where

GenericWidgets

data GenericWidget control a Source #

Constructors

GenericWidget
Fields widgetTidings :: Tidings a The dynamic contents of the widget. widgetControl :: control The actual widget.

Instances

Bifunctor GenericWidget Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods bimap :: (a -> b) -> (c -> d) -> GenericWidget a c -> GenericWidget b d # first :: (a -> b) -> GenericWidget a c -> GenericWidget b c # second :: (b -> c) -> GenericWidget a b -> GenericWidget a c #
Functor (GenericWidget control) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods fmap :: (a -> b) -> GenericWidget control a -> GenericWidget control b # (<$) :: a -> GenericWidget control b -> GenericWidget control a #
Widget el => Widget (GenericWidget el a) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods getElement :: GenericWidget el a -> Element #
Renderable el => Renderable (GenericWidget el a) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods render :: GenericWidget el a -> UI Element Source # getLayout :: GenericWidget el a -> Layout Source #

edited :: GenericWidget el a -> Event a Source #

contents :: GenericWidget el a -> Behavior a Source #

widgetControl :: GenericWidget control a -> control Source #

The actual widget.

widgetTidings :: GenericWidget control a -> Tidings a Source #

The dynamic contents of the widget.

Editors

newtype Editor outer widget inner Source #

An editor for values of type inner inside a datatype outer realized by a widget.

All the three type arguments are functorial, but outer is contravariant, so Editor is a Biapplicative functor and a Profunctor (via dimapE).

Biapplicative allows to compose editors on both their widget and inner structure. When widget is monoidal, widget composition is implicit and Applicative suffices.

Profunctor allows to apply an inner editor to an outer datatype.

Once created, an Editor yields a tuple of an widget and a Tidings inner which can be integrated in a threepenny app.

Constructors

Editor
Fields create :: Behavior outer -> UI (GenericWidget widget inner)

Bundled Patterns

pattern Horizontally :: Editor a Layout b -> Editor 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 :: Editor a Layout b -> Editor 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

Instances

Bifunctor (Editor a) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods bimap :: (a0 -> b) -> (c -> d) -> Editor a a0 c -> Editor a b d # first :: (a0 -> b) -> Editor a a0 c -> Editor a b c # second :: (b -> c) -> Editor a a0 b -> Editor a a0 c #
Biapplicative (Editor a) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods bipure :: a0 -> b -> Editor a a0 b # (<<>>) :: Editor a (a0 -> b) (c -> d) -> Editor a a0 c -> Editor a b d # biliftA2 :: (a0 -> b -> c) -> (d -> e -> f) -> Editor a a0 d -> Editor a b e -> Editor a c f # (>>) :: Editor a a0 b -> Editor a c d -> Editor a c d # (<<*) :: Editor a a0 b -> Editor a c d -> Editor a a0 b #
Functor (Editor a el) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods fmap :: (a0 -> b) -> Editor a el a0 -> Editor a el b # (<$) :: a0 -> Editor a el b -> Editor a el a0 #
Monoid el => Applicative (Editor a el) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods pure :: a0 -> Editor a el a0 # (<>) :: Editor a el (a0 -> b) -> Editor a el a0 -> Editor a el b # liftA2 :: (a0 -> b -> c) -> Editor a el a0 -> Editor a el b -> Editor a el c # (>) :: Editor a el a0 -> Editor a el b -> Editor a el b # (<*) :: Editor a el a0 -> Editor a el b -> Editor a el a0 #

liftElement :: UI el -> Editor a el () Source #

Lift an HTML element into a vacuous editor.

dimapE :: (a' -> a) -> (b -> b') -> Editor a el b -> Editor a' el b' Source #

applyE :: (el1 -> el2 -> el) -> Editor in_ el1 (a -> b) -> Editor in_ el2 a -> Editor in_ el b Source #

Editor composition

(|*|) :: Editor s Layout (b -> a) -> Editor s Layout b -> Editor s Layout a infixl 4 Source #

Left-right editor composition

(|*) :: Editor s Layout a -> UI Element -> Editor s Layout a infixl 5 Source #

Left-right composition of an element with a editor

(*|) :: UI Element -> Editor s Layout a -> Editor s Layout a infixl 5 Source #

Left-right composition of an element with a editor

(-*-) :: Editor s Layout (b -> a) -> Editor s Layout b -> Editor s Layout a infixl 4 Source #

Left-right editor composition

(-*) :: Editor s Layout a -> UI Element -> Editor s Layout a infixl 5 Source #

Left-right composition of an element with a editor

(*-) :: UI Element -> Editor s Layout a -> Editor s Layout a infixl 5 Source #

Left-right composition of an element with a editor

field :: Renderable m => String -> (out -> inn) -> Editor inn m a -> Editor out Layout a Source #

A helper that arranges a label and an editor horizontally.

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

A helper that arranges a label and an editor horizontally, wrapped in the given monoidal layout builder.

Editor constructors

editorUnit :: Editor b Element b Source #

editorIdentity :: Editor a el a -> Editor (Identity a) el (Identity a) Source #

editorString :: Editor String TextEntry String Source #

editorText :: Editor Text TextEntry Text Source #

editorCheckBox :: Editor Bool Element Bool Source #

editorReadShow :: (Read a, Show a) => Editor (Maybe a) TextEntry (Maybe a) Source #

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

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

An editor that presents a dynamic choice of values.

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

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

editorJust :: Editor (Maybe b) el (Maybe b) -> Editor b el b Source #

Ignores Nothing values and only updates for Just values

data EditorCollection k w Source #

Constructors

EditorCollection
Fields selector :: ListBox k add, remove :: Element selected :: w

Instances

Renderable w => Renderable (EditorCollection k w) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Types Methods render :: EditorCollection k w -> UI Element Source # getLayout :: EditorCollection k w -> Layout Source #

editorCollection :: forall k v w. (Ord k, Renderable w) => (Behavior (Maybe k, Map k v) -> EditorCollectionConfig k v) -> Editor v w v -> Editor (Maybe k, Map k v) (EditorCollection k w) (Maybe k, Map k v) Source #

A barebones editor for collections of editable items. Displays an index selector, add and delete buttons, and an editor for the selected item. Limitations: - Won't work with recursive data structures, due to the lack of FRP switch.

editorList :: (HasEmpty a, Renderable w) => Editor a w a -> Editor (Maybe Int, [a]) (EditorCollection Int w) (Maybe Int, [a]) Source #

A barebones editor for collections of editable items. Displays an index selector, add and delete buttons, and an editor for the selected item. Limitations: - Won't work with recursive data structures, due to the lack of FRP switch.

data EditorCollectionConfig k v Source #

Constructors

EditorCollectionConfig
Fields eccNewKey :: Behavior k Current value to use for creating a new key eccAfterDelKey :: Behavior (Maybe k) Current value to use if the selected key is deleted eccTemplate :: v Value to use for creating new items eccOptions :: Behavior (Set k) Currently user select able keys eccDisplay :: Behavior (k -> UI Element) How to render a key

defaultEditorCollectionConfig :: (Enum k, Ord k, Show k, HasEmpty v) => Behavior (Maybe k, Map k v) -> EditorCollectionConfig k v Source #

Representation of empty values

class HasEmpty a where Source #

This class defines how to represent empty values in a UI. A generic derivation is available for every SOP type.

Methods

emptyValue :: a Source #

emptyValue :: (Generic a, HasEmptyCode (Code a), All HasEmpty (Head (Code a))) => a Source #

Instances

HasEmpty Bool Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Bool Source #
HasEmpty Char Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Char Source #
HasEmpty Double Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Double Source #
HasEmpty Int Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Int Source #
HasEmpty () Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: () Source #
HasEmpty Text Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Text Source #
HasEmpty [a] Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: [a] Source #
HasEmpty (Maybe a) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Maybe a Source #
HasEmpty a => HasEmpty (Identity a) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Identity a Source #
HasEmpty (Seq k) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Seq k Source #
Ord k => HasEmpty (Set k) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Set k Source #
HasEmpty a => HasEmpty (I a) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors Methods emptyValue :: I a Source #
(HasEmpty a, HasEmpty b) => HasEmpty (a, b) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: (a, b) Source #
Ord k => HasEmpty (Map k v) Source #
Instance details Defined in Data.HasEmpty Methods emptyValue :: Map k v Source #
(HasEmpty a, HasEmpty b) => HasEmpty (a -*- b) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Layout Methods emptyValue :: a -*- b Source #
(HasEmpty a, HasEmpty b) => HasEmpty (a \|*\| b) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors.Layout Methods emptyValue :: a \|*\| b Source #
All HasEmpty xs => HasEmpty (NP I xs) Source #
Instance details Defined in Graphics.UI.Threepenny.Editors Methods emptyValue :: NP I xs Source #