Parameter Make._

The interface that must be implemented to create a problem type.

type t

Type of the data associated with this problem controller

include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t Base__Ppx_compare_lib.compare
type settings_action

The actions that can be taken by updating the settins of this controller.

val sexp_of_settings_action : settings_action -> Sexplib0.Sexp.t
val settings_action_of_sexp : Sexplib0.Sexp.t -> settings_action
val init : unit -> t

Get an controler that will be used to show the first problem.

val next : t -> t

Generate the next problem.

val problem : t -> string

Get the text of the current problem.

val description : t -> string

Description to show above the problem.

val should_submit : t -> string -> bool

Checks whether the problem should submit given the current text in the input. This function will often check for a newline character to see if the user has clicked the enter button. If should_submit returns true, leading and trailing whitespace will be removed from the input.

val submit : t -> string -> (string, string) Core.result

Submit the answer to the current problem. If the returned result is Ok s then the string s will be displayed in green text. If Error s is returned s will be displayed in red text.

val on_tab : t -> Js_of_ocaml.Dom_html.textAreaElement Js_of_ocaml.Js.t -> unit

This function is called whenever the user clicks the tab button while the input box is focused. This allows you to perform actions and modifications to the contents of the text box.

The settings associated with this controller.

val update_settings : t -> settings_action -> t

Updates a setting in the controller.