package stk

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Utilities for popup menus

package stk

stk
- Stk
  - App
  - Bin
    
    PScrollbar_policy
    
    TScrollbar_policy
    
    bin
    
    event_box
    
    fixed_size
    
    scrollbox
  - Button
    
    button
    
    checkbutton
    
    group
    
    togglebutton
  - Canvas
    
    box
    
    canvas
    
    container_item
    
    fixed_size
    
    flex
    
    full_item
    
    glyph
    
    group
    
    item
    
    label
    
    paned
    
    rect
  - Clist
    
    cell
    
    cell_
    
    clist
    
    label_cell
    
    text_cell
  - Color
  - Container
    
    container
  - Default_app
    
    app
  - Dialog
    
    dialog
  - Edit
    
    entry
  - Events
  - Flex
    
    flex
    
    space
  - Fmts
  - Font
  - Frame
    
    frame
  - G
  - Image
    
    image
  - Key
  - Layer
    
    Map
    
    Ord
  - Log
    
    LOG
  - Menu
    
    menu
    
    menubar
    
    menuitem
  - Misc
    
    Base_id
    
    IMap
    
    ISet
    
    Id
    
    Map
    
    Idset
    
    I
    
    SMap
  - Notebook
    
    notebook
  - Object
    
    o
  - Oid
    
    I
    
    Map
  - Pack
    
    box
    
    paned
  - Packer
  - Props
    
    Add_prop_type
    
    T
    
    Id
    
    Map
    
    PBool
    
    PColor
    
    PFloat
    
    PFont_desc
    
    PInt
    
    PLayer
    
    PPair
    
    T1
    
    T2
    
    PPair_float
    
    PProps
    
    PString
    
    PT
    
    PTrbl
    
    T
    
    PTrbl_color
    
    PTrbl_int
    
    PUchar
    
    Prop_type
    
    TColor
    
    TInt
    
    TProps
  - Range
    
    range
  - Render
  - Rope
  - Selection
  - Text
    
    Status_msg_id
    
    Map
    
    glyph
    
    label
    
    status
    
    textured_glyph
    
    textured_text
  - Textbuffer
    
    Cursor_map
  - Textlog
    
    textlog
  - Texttag
    
    Lang
    
    T
    
    TMap
    
    TSet
    
    Theme
  - Texture
  - Textview
    
    textview
  - Theme
  - Tree
    
    IMap
    
    ISet
    
    Id
    
    Map
    
    tree
  - Utf8
  - Widget
    
    Map
    
    Set
    
    widget
  - Window
    
    window
  - Wkey

Legend:
Library
Module
Module type
Parameter
Class
Class type

Menus and menubars.

type item_menu_state =

| Folded
| Unfolded

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

val item_menu_state_wrapper : item_menu_state Ocf.Wrapper.t

val item_menu_state : item_menu_state Props.prop

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

val shortcut : Key.keystate Props.prop

Keyboard "shortcut" property for a menu.

class menuitem : ?class_:string option -> ?name:string option -> ?props:Props.t 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.

class menu : ?class_:string option -> ?name:string option -> ?orientation:Props.orientation
                                                                  option -> ?props:
  Props.t
    option -> unit -> object ... end

Menu widget.

class menubar : ?class_:string option -> ?name:string option -> ?orientation:Props.orientation
                                                                  option -> ?props:
  Props.t
    option -> unit -> object ... end

Menubar widget.

val menubar : 
  ?class_:string ->
  ?name:string ->
  ?orientation:Props.orientation ->
  ?props:Props.t ->
  ?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.

val menuitem : 
  ?class_:string ->
  ?name:string ->
  ?props:Props.t ->
  ?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.

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

Convenient function to create a menuitem with a horizontal Pack.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).

val menu : 
  ?class_:string ->
  ?name:string ->
  ?props:Props.t ->
  ?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.

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

val popup_menu_entries : 
  [< `C of 'b | `I of string * (unit -> unit) | `M of string * 'a | `R of 'c ]
    list as 'a ->
  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.

package stk

Utilities for popup menus