Index of values

Modifying the widget

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.

Add a screen on top of the layout.

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.

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 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 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.

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.

Ask Bogue to destroy the window.

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

Mark an element for skipping its execution.

This makes sure that nothing is executed when someone tries to resize the layout.

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

If the exit_on_escape shortcut is given to the Main.make function, then the Main.Exit exception will be raised 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.

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.

Number of displayed frames since startup.

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

multiplies get_size by the Theme scaling factor.

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.

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>, <p>,</p>, <br>

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.

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.

Load a WAV file.

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

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.

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

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).

Similar to Main.of_layout but with only one layout.

Similar to Main.create.

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 resized functions.

Here the optional parameters w and h set the width and height of the button.

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

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.

Remove the Sdl_area.draw_element from the command queue.

Like Option.get.

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).

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 ().

Conversion: Bogue dimension -> hardware pixel dimension.

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

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.

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_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 the widget is not rendered yet, a default size may be returned instead of the true size.

Return the logical size (w,h).

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.

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

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.

size is the font size.

Same as Tsdl.Sdl.Event.text_input

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.

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

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

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

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