To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
Dealing with events.
Events are simply SDL events, plus a few additional events. They are also used for primitive communication between threads.
Events are detected by Layouts, and then sent to the resident Widget. Finally, the Widget decides what to do with the events. There is one exception: the
startup event is directly sent to all Widgets.
type t = Tsdl.Sdl.event_type
val text_input : t
Same as Tsdl.Sdl.Event.text_input
val key_down : t
Same as Tsdl.Sdl.Event.key_down
val key_up : t
Same as Tsdl.Sdl.Event.key_up
Special Bogue events
val startup : t
startup event is sent to all Widgets when the Bogue mainloop is started using
val mouse_enter : t
mouse_enter event is triggered when the pointer (mouse motion, or finger touch -- but not finger drag) enters a new layout.
val mouse_leave : t
mouse_enter, when the pointer leaves the layout.
val mouse_at_rest : t
Triggered when the mouse did not move for a while.
val var_changed : t
var_changed event can be sent to notify that some widget made a change to a global variable.
val update : t
update event is more or less equivalent to
var_changed. This might change in future versions.
val user_event : t
Tsdl.Sdl.Event.user_event. This special event of type SDL_UserEvent can trigger a global reaction, not associated with any widget in particular, through the
on_user_event parameter of
A list of events containing the mouse_button_down event, and the finger_down event.
A list of events containing the mouse_button_up event, and the finger_up event.
val pointer_motion : t list
A list of events containing the mouse_motion event, and the finger_motion event.
Using events for terminating threads
val should_exit : Tsdl.Sdl.event -> bool
Tell if the current thread should exit. This should only be called within a widget action. The event should be the event passed to the action function. A well programmed action should check this event to decide if it should exit.
val will_exit : Tsdl.Sdl.event -> unit
A nice thread should do this just before terminating. May be suppressed in future versions.
val nice_delay : Tsdl.Sdl.event -> float -> unit
nice_delay ev t Wait during a delay (
t seconds), but quit anyway when
ev is true.
Send the SDL_QUIT event, as if the user clicked on the close button of the last existing window. It will in principle raise the
Main.Exit exception and hence exit the mainloop.
val wait_for : ?timeout:float -> ?ev:Tsdl.Sdl.event -> (unit -> bool) -> unit
type sdl_event = [
`Unknown of int
val event_kind : Tsdl.Sdl.event -> [ sdl_event | bogue_event ]