package bogue

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Dependency graph

bogue
- Bogue
  - Avar
  - Box
  - Button
  - Check
  - Draw
  - Image
  - Label
  - Layout
  - Long_list
  - Main
  - Menu
  - Mixer
  - Mouse
  - Popup
  - Print
  - Radiolist
  - Select
  - Selection
  - Slider
  - Snapshot
  - Space
  - Style
  - Sync
  - Table
  - Tabs
  - Text_display
  - Text_input
  - Theme
  - Time
  - Timeout
  - Trigger
  - Tvar
  - Update
  - Utils
  - Var
  - Widget

Legend:
Library
Module
Module type
Parameter
Class
Class type

Various types of menus

The generic create function produces menus whose entries can be arbitrary layouts located at arbitrary places. But for usual entries, it is enough to provide a string for the entry label, and the layout will be constructed automatically.

The specialized bar function will produce a familiar menu bar with drop-down submenus.

Dependency graph

type t

type action = unit -> unit

type label =

| Text of string
| Layout of Layout.t

type entry = {

label : label;
content : content;

}

and content =

| Action of action
| Flat of entry list
(*
A Flat content will produce a horizontal menu
*)
| Tower of entry list
(*
A Tower content will produce a vertical menu
*)
| Custom of entry list
(*
In a Custom content, only Layout labels should be used, and their position should be defined before creating the menu.
*)
| Separator
(*
Currently only used for inserting separator lines in Tower menus.
*)

val create : ?dst:Layout.t -> content -> t

Generic menu creation, inserted in the dst layout.

val add_bar : dst:Layout.t -> entry list -> unit

Creation of a menu bar in the dst layout, with drop-down submenus. bar dst entries inserts a layout which contains the menu bar into the top of the dst layout (so, some room should be provided). The dst layout should be big enough to contain the submenus. Any item flowing out of dst will not get focus.

val bar : entry list -> Layout.t

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

val separator : entry