Monomer.Widgets.Singles.Base.InputField

Base single line text editing field. Extensible for handling specific textual representations of other types, such as numbers and dates. It is not meant for direct use, but to create custom widgets using it.

See NumericField, DateField and TimeField.

Documentation

data InputFieldCfg s e a

Configuration options for an input field. These options are not directly exposed to users; each derived widget should expose its own options.

Constructors

InputFieldCfg

Fields

• _ifcPlaceholder :: Maybe Text

  Placeholder text to show when input is empty.

• _ifcInitialValue :: a

  Initial value for the input field, before retrieving from model.

• _ifcValue :: WidgetData s a

  Where to get current data from.

• _ifcValid :: Maybe (WidgetData s Bool)

  Flag to indicate if the field is valid or not, using a lens.

• _ifcValidV :: [Bool -> e]

  Flag to indicate if the field is valid or not, using an event handler.

• _ifcDefCursorEnd :: Bool

  Whether to put cursor at the end of input on init. Defaults to False.

• _ifcDefWidth :: Double

  Default width of the input field.

• _ifcCaretWidth :: Maybe Double

  Caret width.

• _ifcCaretMs :: Maybe Int

  Caret blink period.

• _ifcDisplayChar :: Maybe Char

  Character to display as text replacement. Useful for passwords.

• _ifcResizeOnChange :: Bool

  Whether input causes ResizeWidgets requests. Defaults to False.

• _ifcSelectOnFocus :: Bool

  If all input should be selected when focus is received.

• _ifcFromText :: Text -> Maybe a

  Conversion from text to the expected value. Failure returns Nothing.

• _ifcToText :: a -> Text

  Conversion from a value to text. Cannot fail.

• _ifcAcceptInput :: Text -> Bool

  Whether to accept the current input status. The conversion fromText may still fail, but input still will be accepted. This is used, for instance, in date fields when input is not complete and a valid date cannot be created.

• _ifcIsValidInput :: Text -> Bool

  Whether the current text is valid input. Valid input means being able to convert to the expected type, and after that conversion the value matches the expected constraints (for instance, a well formed number between 1 and 100).

• _ifcStyle :: Maybe (ALens' ThemeState StyleState)

  Base style retrieved from the active theme.

• _ifcWheelHandler :: Maybe (InputWheelHandler a)

  Handler for wheel events.

• _ifcDragHandler :: Maybe (InputDragHandler a)

  Handler for drag events.

• _ifcDragCursor :: Maybe CursorIcon

  Cursor to display on drag events.

• _ifcOnFocusReq :: [Path -> WidgetRequest s e]

  WidgetRequest to generate when focus is received.

• _ifcOnBlurReq :: [Path -> WidgetRequest s e]

  WidgetRequest to generate when focus is lost.

• _ifcOnChangeReq :: [a -> WidgetRequest s e]

  WidgetRequest to generate when value changes.

data InputFieldState a

Current state of the input field. Provided to some event handlers.

Constructors

InputFieldState

Fields

• _ifsPlaceholder :: Seq TextLine

  The placeholder text to show when input is empty. Does not depend on cursor position.

• _ifsCurrValue :: a

  The latest valid value.

• _ifsCurrText :: !Text

  The latest accepted input text.

• _ifsCursorPos :: !Int

  The current cursor position.

• _ifsSelStart :: Maybe Int

  The selection start. Once selection begins, it doesn't change until done.

• _ifsDragSelValue :: a

  The value when drag event started.

• _ifsGlyphs :: Seq GlyphPos

  The glyphs of the current text.

• _ifsOffset :: !Double

  The offset of the current text, given cursor position and text length.

• _ifsTextRect :: Rect

  The rect of the current text, given cursor position and text length.

• _ifsTextMetrics :: TextMetrics

  Text metrics of the current font and size.

• _ifsHistory :: Seq (HistoryStep a)

  Edit history of the current field. Supports undo and redo.

• _ifsHistIdx :: Int

  Current index into history.

• _ifsFocusStart :: Int

  The timestamp when focus was received (used for caret blink)

Instances

Eq a => Eq (InputFieldState a)

Defined in Monomer.Widgets.Singles.Base.InputField

Methods

(==) :: InputFieldState a -> InputFieldState a -> Bool

(/=) :: InputFieldState a -> InputFieldState a -> Bool

Show a => Show (InputFieldState a)

Defined in Monomer.Widgets.Singles.Base.InputField

Methods

showsPrec :: Int -> InputFieldState a -> ShowS

show :: InputFieldState a -> String

showList :: [InputFieldState a] -> ShowS

Generic (InputFieldState a)

Defined in Monomer.Widgets.Singles.Base.InputField

Associated Types

type Rep (InputFieldState a) :: Type -> Type

Methods

from :: InputFieldState a -> Rep (InputFieldState a) x

to :: Rep (InputFieldState a) x -> InputFieldState a

type Rep (InputFieldState a)

Defined in Monomer.Widgets.Singles.Base.InputField

type Rep (InputFieldState a)

inputField_ :: (InputFieldValue a, WidgetEvent e) => WidgetType -> InputFieldCfg s e a -> WidgetNode s e

Creates an instance of an input field, with customizations in config.