| Safe Haskell | None |
|---|
Hbro.Prompt
Description
Designed to be imported as qualified.
- data PromptBar m = PromptBar {
- _box :: HBox
- _description :: Label
- _entry :: Entry
- _onChanged :: IORef (String -> m ())
- _onValidated :: IORef (String -> m ())
- onChanged :: forall m. Lens' (PromptBar m) (IORef (String -> m ()))
- onValidated :: forall m. Lens' (PromptBar m) (IORef (String -> m ()))
- entry :: forall m. Lens' (PromptBar m) Entry
- description :: forall m. Lens' (PromptBar m) Label
- box :: forall m. Lens' (PromptBar m) HBox
- class (Monad m, Monad n) => PromptReader n m | m -> n where
- readPrompt :: Simple Lens (PromptBar n) a -> m a
- init :: (MonadBase IO m, MonadBaseControl IO m, NotificationReader m, Error e, Show e, MonadError e m) => PromptBar m -> m ()
- open :: (Functor m, MonadBase IO m, PromptReader n m, MonadWriter String m) => String -> String -> m ()
- hide :: (MonadBase IO m, PromptReader n m) => m ()
- clean :: (MonadBase IO m, PromptReader n m) => m ()
- read :: (MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) => String -> String -> (String -> m ()) -> m ()
- incrementalRead :: (MonadBase IO m, MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) => String -> String -> (String -> m ()) -> m ()
- iread :: (MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) => String -> String -> (String -> m ()) -> m ()
- readURI :: (MonadBase IO m, PromptReader m m, MonadError HError m, MonadWriter String m) => String -> String -> (URI -> m ()) -> m ()
- getEntryValue :: (MonadBase IO m, PromptReader n m) => m String
Documentation
Constructors
| PromptBar | |
Fields
| |
description :: forall m. Lens' (PromptBar m) LabelSource
class (Monad m, Monad n) => PromptReader n m | m -> n whereSource
Methods
readPrompt :: Simple Lens (PromptBar n) a -> m aSource
Instances
init :: (MonadBase IO m, MonadBaseControl IO m, NotificationReader m, Error e, Show e, MonadError e m) => PromptBar m -> m ()Source
open :: (Functor m, MonadBase IO m, PromptReader n m, MonadWriter String m) => String -> String -> m ()Source
hide :: (MonadBase IO m, PromptReader n m) => m ()Source
clean :: (MonadBase IO m, PromptReader n m) => m ()Source
Close prompt, clean its content and callbacks
Arguments
| :: (MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) | |
| => String | Prompt description |
| -> String | Initial value |
| -> (String -> m ()) | Function to trigger when validating prompt value |
| -> m () |
Open prompt bar with given description and default value, and register a callback to trigger at validation.
incrementalRead :: (MonadBase IO m, MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) => String -> String -> (String -> m ()) -> m ()Source
Same as read, but callback is triggered for each change in prompt's entry.
iread :: (MonadBaseControl IO m, PromptReader m m, Error e, MonadError e m, MonadWriter String m) => String -> String -> (String -> m ()) -> m ()Source
Alias for incrementalRead.
readURI :: (MonadBase IO m, PromptReader m m, MonadError HError m, MonadWriter String m) => String -> String -> (URI -> m ()) -> m ()Source
Same as read for URI values
getEntryValue :: (MonadBase IO m, PromptReader n m) => m StringSource