package bogue

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Dependency graph

package bogue

bogue
- Bogue
  - Avar
  - Box
  - Button
  - Check
  - Draw
  - Image
  - Label
  - Layout
  - Long_list
  - Main
  - Menu
  - Menu2
  - 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

Dependency graph

type t

type simple_entry = {

text : string;
action : unit -> unit;

}

type mutable_text = {

mutable text : string;
action : string -> unit;
(*
The text can be modified by the action
*)

}

type check_entry = {

mutable state : bool;
(*
A check box before the label, and the text is modifiable
*)
mutable text : string;
action : string -> bool -> unit;

}

type layout_entry = {

layout : Layout.t;
selected : bool Var.t;
action : Layout.t -> unit;
submenu : t option;

}

type label =

| Label of simple_entry
| Dynamic of mutable_text
| Check of check_entry
| Layout of layout_entry

type entry = {

label : label;
submenu : entry list option;

}

val create_menu : ?depth:int -> layout_entry array -> bool -> t

The depth indicates the level of submenu. By default depth=0. The bool parameter indicate whether the menu should be initially shown.

val create : 
  ?hide:bool ->
  ?name:string ->
  ?background:Layout.background ->
  ?select_bg:Layout.background ->
  dst:Layout.t ->
  t ->
  Layout.t

By default, hide=false. The dst layout will contain the submenus.

returns
the layout of the main menu. This is generic menu construction function, it does not compute the positions of the entries. See example41.

val bar : 
  ?background:Layout.background ->
  ?name:string ->
  Layout.t ->
  entry list ->
  Layout.t

A menu bar, with drop-down submenus. bar dst entries creates a layout which contains the menu bar on top of the dst layout. The dst layout should be big enough to contain the submenus. Any item flowing out of dst will not get focus. The system will automatically try to shift the submenus if they are too wide, or add a scrollbar if they are too tall.