Module Bogue

module Bogue: sig .. end

This documentation is best viewed on this page. (While on ocaml.org some links may be broken.)

Quick start

For a quick start, see Bogue's general principles, the minimal example, and the tutorials. (Again, if the links don't work, make sure you are viewing this page from here.)

The main modules are

• Main (creating, running, and quitting your app),
• Layout (arranging widgets to form sophisticated interfaces like table, menus, etc.) and
• Widget (the building blocks, like labels, buttons, etc.).

• Index of types
• Index of exceptions
• Index of values
• Index of modules

List of Modules

The only thing that open Bogue does is to bring these modules into your namespace. They have quite common names, so beware of conflict. In case of doubt, don't open Bogue, and access 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

module Theme: sig .. end

module Utils: sig .. end

module Time: sig .. end

module Var: sig .. end

module Timeout: sig .. end

module Trigger: sig .. end

module Mixer: sig .. end

module Sync: sig .. end

module Draw: sig .. end

module Mouse: sig .. end

module Tvar: sig .. end

module Avar: sig .. end

module Selection: sig .. end

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

The main module for dealing with widgets is Widget.

module Image: sig .. end

module Style: sig .. end

module Label: sig .. end

module Button: sig .. end

module Slider: sig .. end

module Check: sig .. end

module Text_display: sig .. end

module Text_input: sig .. end

module Box: sig .. end

module Sdl_area: sig .. end

module Widget: sig .. end

module Update: sig .. end

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.

module Layout: sig .. end

module Space: sig .. end

module Print: sig .. end

module Snapshot: sig .. end

module Long_list: sig .. end

module Tabs: sig .. end

module Popup: sig .. end

module Menu: sig .. end

module Select: sig .. end

module Radiolist: sig .. end

module Table: sig .. end

module Window: sig .. end

The Bogue mainloop

Because a GUI continuously waits for user interaction, everything has to run inside a loop. You start the loop with run, and this is usually the last command of your Bogue code.

module Main: sig .. end

module Bogue: 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.of_layout 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

Then execute the compiled code:

./minimal

A window should open which should look like this:

You may also evaluate 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.