Menu (p.stk.0.5.0.doc.stk.Stk.Menu)

Sourcetype item_menu_state =

| Folded
| Unfolded

A menu item with a menu attached can be either Folded or Unfolded.

Sourceval item_menu_state_wrapper : item_menu_state Ocf.Wrapper.t

Sourceval item_menu_state : item_menu_state Props.prop

Property "item_menu_state" for menu state. Default is Folded.

Sourceval shortcut : Key.keystate Props.prop

Keyboard "shortcut" property for a menu.

Sourcetype Container.child_data +=

| Menu_item of Widget.widget * Events.callback_id

Associating menuitem and callback_id to menu's children. Parameter is a widget since menu and menuitem classes are recursive, we cannot define this constructor after menuitem but before menu.

Source

class menuitem : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata:
  Widget.wdata
    option -> unit -> object ... end

An entry in a menu. The child of the entry is displayed in the menu. A (sub)menu can be attached to the item. In this case, when the item is unfolded, its attached menu is displayed.

Source

class menu : ?classes:string list option -> ?name:string option -> ?orientation:
  Props.orientation
    option -> ?props:Props.t option -> ?wdata:Widget.wdata option -> 
  unit -> object ... end

Menu widget.

Source

class menubar : ?classes:string list option -> ?name:string option -> ?orientation:
  Props.orientation
    option -> ?props:Props.t option -> ?wdata:Widget.wdata option -> 
  unit -> object ... end

Menubar widget.

Sourcetype Widget.widget_type +=

| Menuitem of menuitem
| Menu of menu
| Menubar of menubar

Source

val menubar : 
  ?classes:string list ->
  ?name:string ->
  ?orientation:Props.orientation ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  menubar

Convenient function to create a menubar. Optional argument orientation defines vertical or horizontal orientation; default is Horizontal. See Widget arguments for other arguments.

Source

val menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?shortcut:Key.keystate ->
  ?pack:(menuitem -> unit) ->
  unit ->
  menuitem

Convenient function to create a menuitem. Optional argument shortcut defines keyboard shortcut. See Widget arguments for other arguments.

Source

val label_menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?text:string ->
  ?shortcut:Key.keystate ->
  ?pack:(menuitem -> unit) ->
  unit ->
  menuitem * Text.label

Convenient function to create a menuitem with a horizontal Box.box child. Two label widgets are added to the box. The first one is the label of the item (with initial text if provided). Optional argument shortcut defines keyboard shortcut and it is displayed in the second label (which has class "menuitem_shortcut"). See Widget arguments for other arguments. The function returns the menu item and the first label (the one for the menu item text).

Source

val check_menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?shortcut:Key.keystate ->
  ?active:bool ->
  ?pack:(menuitem -> unit) ->
  ?group:< add : Widget.widget -> 'a ; set_active : Widget.widget -> unit.. > ->
  < as_widget : Widget.widget.. > ->
  menuitem

Source

val label_check_menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?shortcut:Key.keystate ->
  ?active:bool ->
  ?text:string ->
  ?group:< add : Widget.widget -> 'a ; set_active : Widget.widget -> unit.. > ->
  ?pack:(menuitem -> unit) ->
  unit ->
  menuitem * Text.label

Source

val radio_menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?shortcut:Key.keystate ->
  ?active:bool ->
  ?pack:(menuitem -> unit) ->
  < add : Widget.widget -> 'a ; set_active : Widget.widget -> unit.. > ->
  < as_widget : Widget.widget.. > ->
  menuitem

Source

val label_radio_menuitem : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?shortcut:Key.keystate ->
  ?active:bool ->
  ?text:string ->
  ?pack:(menuitem -> unit) ->
  < add : Widget.widget -> 'a ; set_active : Widget.widget -> unit.. > ->
  menuitem * Text.label

Source

val menu : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?pack:(menu -> unit) ->
  unit ->
  menu

Convenient function to create a menu. Optional argument orientation defines vertical or horizontal orientation; default is Vertical. See Widget arguments for other arguments.

Sourcetype menu_entry = [

| `I of string * (unit -> unit)
| `C of string * bool * (bool -> unit)
| `R of (string * bool * (bool -> unit)) list
| `M of string * menu_entry list

]

Menu entry description:

`I (text, cb) is a label item with text, and cb is called when item is activated.
`C (text, init, cb) is a checkbox item with text; init indicates whether the box is checked and cb is called with state when item is activated.
`R [(text1, init1, cb1) ; ...] is same as `C but describes a list of radiobuttons.
`M (text, entries) describes a submenu with text for the menu item and a list of entries.

Sourceval popup_menu_entries : menu_entry list -> unit

popup_menu_entries entries create a menu according to the entries description and pops it up. The menu is closed when an item is activated (or an event occurs closing menu windows). This function is typically used for contextual menus.

Utilities for popup menus