Index of values

activate mbx handler sets the owner widget ready to receive messages, and each received message will be handled by the handler function.

Warning: two Text_input widgets cannot be active at the same time.

Create helper functions to help controlling the frame rate of the graphics loop.

add area ~name f adds the arbitrary command f to the render queue.

add delay action will execute action () (in the main thread) after the delay of delay ms.

Creation of a menu bar in the dst layout, with drop-down submenus.

Registers the connection with the widget.

Append the element to the end of the command queue.

Similar to Sdl_area.add, but returns the corresponding Sdl_area.draw_element.

Same as add except that this does not return the Timeout element.

Add a screen on top of the layout.

add_translation locale text translation will declare the string translation to be the translation of the string text within the current context and for the given locale.

Assign an Avar to the layout x position.

apply f v creates a new Avar by composing with f; the old Avar v is still active

Generic modal type popup

Set the layout to automatically scale its inner rooms when the layout size is modified.

Return a menu layout that will be installed with Menu.add_bar into the top house at startup.

Return the full path of the currently displayed directory.

Create a Box widget, which simply displays a rectangle, optionally with rounded corners and drop shadow.

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.

This will insert a special command in the queue that will save the texture obtained at that point, and clear all previous commands in the queue.

Cancel the Timeout.

Multiply sound intensity by a float factor

let b,l = check_box_with_label text creates a check box b, a label l, and connect them so that clicking on the text will also act on the check box.

circle renderer ~width ~color ~radius ~x ~y draws a circle with given line thickness, centered at (x,y), with given radius.

Clear the area (this removes all commands from the render queue).

Clear the graphics cache generated by the Sdl_area.cache command.

Construct a background from an RGBA color.

connect source target action triggers creates a connection from the source widget to the target widget, but does not register it (this may change in the future...

Alias for connect ~priority:Main.

Search for the room containing the widget, if any.

Create a board from a list of layouts and connections.

Create a window from the given layout.

Create a table by specifying its list of columns; in each column, the entries can be arbitrary layouts.

create string_array i creates a select box with preselected entry i.

Generic menu creation, inserted in the dst layout.

Create a long list through the function generate which maps any index i to the ieth element (layout) of the list.

Should be called from the main thread only.

Create an empty mailbox which will receive messages of type 'a.

Create an empty SDL area.

The action parameter is executed (with the current button state as argument) just after the button state is modified by mouse clicking or keyboard (on button up or key up).

Create a new Label.t.

create "image.jpg" will load the image "image.jpg".

Generic Avar creation.

create v returns a Var with initial value v.

Load an svg image.

Similar to create but only returns the layout.

create devname creates the mixer an opens the sound device.

Logical ored of !debug with debug flags (below) controls the amount of debuging.

default o v  is the same as Option.value o ~default:v.

Return the delay (in seconds) between two polls.

Ask Bogue to destroy the window.

Emit the destroy_window event to ask Bogue to destroy the SDL window containing the layout.

Use this function if you need unusual combinations of options.

Mark an element for skipping its execution.

This makes sure that nothing is executed when someone tries to resize the layout (that is, when the size of the layout's house changes).

do_option o f is the same as Option.iter f o.

draw_circle c ~color ~thick ~radius (x0, y0) draws a circle of the given line thickness and color inside the disc of center coordinates (x0, y0) and given radius.

draw_line c ~color ~thick (x1, y1) (x2, y2) draws a line of given color and thickness from point (x1, y1) to point (x2, y2).

draw_rectangle c ~color ~thick ~w ~h x0 y0 draws a rectangle of the given line thickness inside the box of top-left coordinates (x0,
        y0), width w and height h.

Size in physical pixels of the target SDL texture on which you can draw.

An empty layout can reserve some space without stealing focus.

Create a widget that does not display anything but still gets focus and reacts to events.

See Sdl_area.disable.

Union of Trigger.sdl_event and Trigger.bogue_event

The exit_on_escape shortcut will raise the Main.Exit exception upon pressing the Escape key.

Animate the alpha channel of the layout.

See Layout.fade_in.

Convert a string of the form "grey" or "#FE01BC" to a rgb code (r,g,b).

find_share app file returns a guessed location for your application share directory (if it exists), for instance /usr/local/share/my_app.

Adapt the size of the layout (and their houses) to the disposition of the contained rooms.

Disable automatic resizing of the rooms inside this layout.

Create a horizontal arrangement from a list of rooms.

Horizontal arrangement of widgets.

Define a font by specifying a filename of a TTF file.

fromto x1 x2 creates a integer Avar.t with initial value x1 and, as time elapses, moves continuously to x2, with a final slowdown.

Similar to Avar.fromto but with uniform speed (no slowdown).

This will set the width of the room (layout) in order to occupy the whole width of its house.

Start the animation (if necessary) and compute the current value of the variable.

get_font_path file returns an absolute path for the given TTF file, if found.

Number of displayed frames since startup.

Return the layout containing the whole file dialog except for the "select" and "cancel" buttons.

Use this layout to display your table.

Return the list of preferred locales as detected from the user's OS.

get_monitor_refresh_rate board returns the monitor refresh rate, for the monitor containing board.

Return the last computed value for the relative x position of the layout.

get_path file returns an absolute path for accessing the given file using the rules described above, except if the file is not found, in which case the string file is returned unchanged, with the hope that it corresponds to a file in the current directory.

multiplies get_size by the Theme scaling factor.

Return the scroll percentage of the Long list, between 0 and 1.

Return the (alphabetically sorted) list of selected files or directories.

Which rows were selected by the user.

get_size l is equivalent to (width l, height l)

Query a boolean state.

Return the text of the widget.

Return the window position within the desktop, in physical pixels.

gettext text tries to return the translation of the text string into the user's preferred language, in the current context.

Similar to gettext but returns None if the translation cannot be found.

Compute the relative x position of the room with respect to its house, using animations if any.

Transform a result into a standard value, or fail with an error.

Check whether the element belongs to the command queue.

When used in a Layout.flat structure, this special empty layout will automatically expand in order to fill the available width in the parent house.

See Layout.show.

Hide the window containing the layout.

Display basic html text by interpreting the following tags: <em>,</em>,
      <b>,</b>, <strong>,</strong>, <u>, </u>, <p>,</p>, <br> and also a color selector with <font color="???">, </font>.

Create a Label widget with a FontAwesome icon.

Create a Label.t using the name of a FontAwesome symbol.

Load image file.

Return a new "Image" widget linked to the same image (same underlying Image.t, hence same texture.)

Requires rsvg.

imax a b returns max(a, b).

imin a b returns min(a, b).

Add to the layout a modal popup with a text and a close button.

Initialize SDL audio.

Not tail-recursive

invert ~first ~last sel returns a selection containing all integers not selected in sel, withing the range [first, last].

Use this to free the textures stored by the layout (and its children) for reducing memory.

Same as Tsdl.Sdl.Event.key_down

Same as Tsdl.Sdl.Event.key_up

Create a Label widget with a one-line text.

The layout to display the radiolist.

Print a layout with all its rooms and subrooms (children).

Print a message to stderr and dump the top_house structure to a temporary file.

Print the layout node and all the rooms (houses, or parents) in which it is contained.

 ( let@ ) f x  is just  f x .

Load a WAV file.

ls m returns the list of files watched by the monitor  m  when the last *modified function was called.

Similar to Main.of_layouts.

Return a layout containing a Text Entry and a Validity indicator; also return a function to examine the validity of the last user entry.

Clip a layout inside a smaller container and make it scrollable, and optionally add a scrollbar widget.

Create a new module for using the given context.

This is only useful if you have your own graphics loop, and do not use Main.run.

Like Space.hfill, but applies to the specified layout instead of creating an empty one.

map_option o f is the same as Option.map f o.

map_text f is a Widget.action that replaces the text of the second widget by f applied to the text of the first widget.

See remarks in Window.set_size.

Same remark.

Hint for minimum width of the table layout; it's up to the user to enforce this.

Note: currently, a border with positive radius is not compatible with a transparent background.

Return three lists of file (or directory) names that have been modified since last call of this function or of was_modified:

Triggered when the mouse did not move for a while.

The mouse_enter event is triggered when the pointer (mouse motion, or finger touch -- but not finger drag) enters a new layout.

Similar to Trigger.mouse_enter, when the pointer leaves the layout.

nice_delay ev t Wait during a delay (t seconds), but quit anyway when Trigger.should_exit ev is true.

none = (0,0,0,0) is completely transparent black.

Time elapsed from the initialization of SDL (roughly, since the start of your program).

Create a table from an array of rows, each row being a string array.

Similar to Main.of_layout but with only one layout.

Similar to Main.create.

Create a table from a list of rows, each row being a string list.

Same as Ti_validate.make, with a validator obtained from a regular expression via Ti_validate.regexp_validator.

Synonym for Main.create.

Similar to Widget.on_release but specialised to button widgets.

Uses priority=Main

Modify the on_close parameter of Window.create.

on_release ~release:f w registers on the widget w the action f, which will be executed when the mouse button is released on this widget.

on_resize room f will execute f () upon resizing the room's house (or the room's window, in case the room is the top house, see Layout.top_house), in addition to the already registered resize functions.

Add to dst the given layout and one button with the button string.

This is only useful if you have your own graphics loop, and do not use Main.run.

Construct a background from an RGB (ie non-transparent) color.

oscillate amplitude x0 will oscillate with the given amplitude around the initial value x0

Return the monitored path.

Play chunk on the desired track number.

A list of events containing the mouse_motion event, and the finger_motion event.

Position of the pointer (mouse or touchscreen that has generated the event) in physical pixels, with respect to the top-left corner of the Sdl_area.

Return the pointer current position.

Get current mouse position.

For instance printd debug_warning "The value x=%u is too big" x will print a message in the console only if the Utils.debug variable contains the debug_warning flag.

progress v is a float in [0,1] giving the percentage of the animation when the last v.value was computed.

Register a widget for being updated (at next frame) by the main loop.

push action registers the action to be executed by the mainloop at the start of the next frame, or at a subsequent frame if the queue is already large.

Emit the close-window event to the window containing the layout, as if the user clicked on the close button.

Send the SDL_QUIT event, as if the user clicked on the close button of the last existing window.

Use this to close SDL windows and cleanup memory, after Main.run has returned.

Cleanup and quit SDL.

rectangle renderer ~color ~thick ~w ~h ~x ~y draws a rectangle with given line thickness.

Adjust an existing layout to arrange its rooms in a "flat" fashion, as if they were created by Layout.flat.

Ask the GUI to refresh (ie.

Construct a validator function from a regular expression.

Unregister the connection.

Remove the Sdl_area.draw_element from the command queue.

Like Option.get.

Remove all the connections from the given widget that respond to the given trigger (=event)

replace ~by:t2 t1 replaces the text content of t1 by the one of t2.

Replace room by by inside its "house" in lieu and place of the initial room.

Create a layout (=room) from a single Widget (=resident).

When asked to resize, the layout will keep the initial 4 margins with respect to its house.

Rotate all widgets inside the layout around their respective centers.

Round float to nearest integer.

This is finally how you run your app! It creates the SDL windows associated with the Window.ts registered with the board, and launches the main loop.

run f is equivalent to f ().

Similar to File.select_file, but here the user can enter a filename that does not already exist in the displayed directory.

Save the translation file for the given locale (including all contexts, and all user additions made with add_translation).

Conversion: Bogue dimension -> hardware pixel dimension.

See Sdl_area.create regarding the size (w,h).

Similar to File.select_file except that here only a directory can be selected.

Similar to File.select_files except that here only directories can be selected.

select_file dirname continue will open a file dialog, initially showing the content of the directory dirname.

Similar to File.select_file except that here several files can be selected.

send mbx msg sends the message msg to the mailbox mbx.

Set a new value.

Modify the text of the label.

set v value waits until no thread is accessing the Var v and then sets its value to value.

Equivalent to Sdl.set_render_draw_color.

Set the current cursor to the default value for this layout.

Set the cursor that should be displayed for this widget.

Disable or enable a layout and all its rooms recursively.

Modify the color of the text.

Set the selected entry to the specified index and directly activate the button's connections with the Trigger.var_changed event.

Set INT_SCALE.

Modify the layout content by replacing the former content by a new list of rooms.

Set window size in physical pixels.

Set a boolean state.

Set the mouse cursor to be the standard system cursor.

Change the text of a widget.

Overrides the Theme TEXT_COLOR variable.

Set the speed of vertical scrolling via the mouse wheel and touchpad.

set_width and similar functions will not work if there is an animation running acting of the variable we want to set (here, the width).

set_window_pos layout x y sets the position of the window containing layout to (x,y), in physical pixels.

Construct shortcuts from a list of (SDL keycode, SDL keymod, action).

Tell if the current thread should exit.

Does nothing if the layout is already fully displayed.

Make the window containing the layout appear onscreen, using set_show and Sdl.show_window.

If t monitors a directory, then size t is the number of elements of this directory, before recent modifications.

If the widget is not rendered yet, a default size may be returned instead of the true size.

Return the logical size (w,h).

Number of selected integers

slide_to room (x0,y0) will translate the room to the position (x0,y0).

Create a slider that executes an action each time the local value of the slider is modified by the user.

start path starts monitoring the directory or file path and immediately returns.

The startup event is sent to all Widgets when the Bogue mainloop is started using Main.run.

The stat_opt and lstat_opt return the corresponding pre-computed Unix.stats results, without actually calling any system function.

Kill the monitoring process.

Stop animations of the variables x and y.

Construct a background from the given Style.

Create a new layout by superposing a list of layouts without changing their (x,y) position.

Same as t_uint but for usual (signed) integers (flag %i).

Same as t_uint but for strings (flag %s).

For instance:

let f = t_uint "%u dollars off coupon" in
print_endline ((tf f) 150)

will print, for French locale:

"bon de réduction de 150 dollars"

as soon as the French translation of "%u dollars off coupon" is declared to be "bon de réduction de %u dollars".

Similar to t_uint but the format string should contain two %s flags.

size is the font size.

Same as Tsdl.Sdl.Event.text_input

Shorthand for Lazy.force.

This is the background constructed from the current theme's BG_COLOR.

Convert BOGUE logical coordinates into pixel coordinates usable for the SDL area.

Convert BOGUE logical coordinates into hardware pixel coordinates.

tooltip text ~target widget layout adds a tooltip which will appear on layout, next to target (which should be a sublayout of layout), when the widget gets mouse focus and mouse is idle for some time on it.

Return the top of the layout tree (the "house" that contains the given layout and that is not contained in another layout).

Create a vertical arrangement from a list of rooms.

Vertical arrangement of widgets.

The list of events that a Text_input can react to.

The list of events that a Slider can react to.

Lazy version of gettext.

If dst is present, a popup containing the given layout (and two buttons) will be contructed inside dst, otherwise a new window will be created.

type_string filename returns the mimetype string of filename, obtained by inspecting only the filename extension (no inspection of the file is done), using this table.

Not tail-recursive

Free the texture associated with the background (if any).

In general, modifying a layout should by done by the main Thread or by using a Sync.push.

Transform a size (W,H) in physical pixels into 'logical' pixels (w,h), which are used for layouts.

update w asks the widget w to refresh at next frame.

Force the area to be re-drawn at the next graphics frame.

Currently the update event is more or less equivalent to var_changed.

Same as Tsdl.Sdl.Event.user_event.

Get current value.

Create an Avar which behaves like a normal Var (no animation).

The var_changed event can be sent to notify that some widget made a change to a global variable.

A radiolist with the usual vertical layout of items.

When used in a Layout.tower structure, this special empty layout will automatically expand in order to fill the available height in the parent house.

Manually init the SDL video system, and detect the scaling factor used by Bogue.

SDL Misc

Simply returns true if files were modified since the last call of this function or of modified.

Return the resident widget, or

A nice thread should do this just before terminating.

Return the SDL window containing the layout.

Return the mouse position with respect to the given window, using window position if necessary.

with_protect v f applies f to the value of v, while protecting v from the access of any other thread.

get current absolute x position of the layout (relative to the top-left corner of the window).

Add to the layout a modal popup with two yes/no buttons.

see Layout.xpos