package bogue

  1. Overview
  2. Docs
package bogue
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module BogueSource

General purpose GUI (Graphical user interface) library for Ocaml.

Bogue is a lightweight and fast GUI for developing desktop applications, games, or for easy debugging of non-GUI programs.

Bogue is entirely written in ocaml except for the hardware accelerated graphics library SDL2.

  • version 20210917
  • author Vu Ngoc San

Quick start

For a quick start, see Bogue's general principles, and the minimal example.

List of Modules

The only thing that open Bogue does is to bring these modules into your namespace. The have quite common names, so beware of conflict. In case of doubt, don't open Bogue, and access to the modules by using the Bogue prefix, for instance Bogue.Widget.label. The Widget and Layout modules are probably the ones that you will find yourself using the most, so it's a good idea to alias them:

module W = Bogue.Widget
module L = Bogue.Layout
Sourcemodule Theme : sig ... end

Theming variables

Sourcemodule Utils : sig ... end

Utilities

Sourcemodule Time : sig ... end

Time in msec

Sourcemodule Var : sig ... end

Global variables with mutex

Sourcemodule Timeout : sig ... end

Delayed actions

Sourcemodule Trigger : sig ... end

Dealing with events

Sourcemodule Mixer : sig ... end

Basic audio mixer for sound effects

Sourcemodule Sync : sig ... end

Synchronized execution queue.

Sourcemodule Draw : sig ... end

Low-level graphics and colors

Sourcemodule Mouse : sig ... end

Mouse and touchscreen information

Sourcemodule Tvar : sig ... end

Transform variables

Sourcemodule Avar : sig ... end

Animated variables

Sourcemodule Selection : sig ... end

Unions of ranges of integers

Widgets

Widgets are building blocks of the GUI. They also receive all events (mouse focus, etc.) and contain the intelligence of your GUI, through connections (or callbacks, see Widget.connection). However, in order to be displayed, they need to be packed into layouts (Layout.t).

Sourcemodule Image : sig ... end

Image widget

Sourcemodule Style : sig ... end

Line and box styles

Sourcemodule Label : sig ... end

One-line text widget

Sourcemodule Button : sig ... end

Button widget with text or icon

Sourcemodule Slider : sig ... end

Slider widget

Sourcemodule Check : sig ... end

Checkbox widget

Sourcemodule Text_display : sig ... end

Multi-line text display widget

Sourcemodule Text_input : sig ... end

One-line text-input widget

Sourcemodule Box : sig ... end

Box widget

Sourcemodule Widget : sig ... end

Creating widgets and giving life to them

Sourcemodule Update : sig ... end

Updating widgets

Layouts

Layouts are rectangular graphical placeholders, in which you should pack all your widgets in order to display your GUI. Sophisticated gadgets are usually obtained by combining several layouts together.

Sourcemodule Layout : sig ... end

The main, all-purpose graphics container

Sourcemodule Space : sig ... end

Adjust various spacings and sizes of layouts

Sourcemodule Print : sig ... end

Convert Bogue objects to strings for debugging

Sourcemodule Snapshot : sig ... end

Create an image from a Layout

Sourcemodule Long_list : sig ... end

Handle large lists by not displaying all elements at once

Sourcemodule Tabs : sig ... end

Switch between layouts using Tabs

Sourcemodule Popup : sig ... end

Put layouts on top of others

Sourcemodule Menu : sig ... end

Various types of menus

Sourcemodule Select : sig ... end

Drop-down select list

Sourcemodule Radiolist : sig ... end

Check list with a single choice

Sourcemodule Table : sig ... end

Tables with sortable columns and selectable rows

The Bogue mainloop

Because a GUI continuously waits for user interaction, everything has to run inside a loop.

Sourcemodule Main : sig ... end

Control the workflow of the GUI mainloop

Sourcemodule Bogue = Main

Alias for Main

Example

Here is a minimal example with a label and a check box.

open Bogue
module W = Widget
module L = Layout

let main () =

  let b = W.check_box () in
  let l = W.label "Hello world" in
  let layout = L.flat_of_w [b;l] in

  let board = Bogue.make [] [layout] in
  Bogue.run board;;

let () = main ();
  Bogue.quit ()

This can be compiled to bytecode with

ocamlfind ocamlc -package bogue -linkpkg -o minimal -thread minimal.ml

and to native code with

ocamlfind ocamlopt -package bogue -linkpkg -o minimal -thread minimal.ml

You may also evaluated this code in a Toplevel! (for instance utop, or in an emacs session...). Just insert

#thread;;
#require "bogue";;

at the top, then paste the example code above, and add ;; at the end.