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
  - Mixer
  - Mouse
  - Popup
  - Print
  - Radiolist
  - Sdl_area
  - Select
  - Selection
  - Slider
  - Snapshot
  - Space
  - Style
  - Sync
  - Table
  - Tabs
  - Text_display
  - Text_input
  - Theme
  - Time
  - Timeout
  - Trigger
  - Tvar
  - Update
  - Utils
  - Var
  - Widget
  - Window

Legend:
Library
Module
Module type
Parameter
Class
Class type

Button widget with text or icon.

Dependency graph

type t

type kind =

| Trigger
| Switch

val create : 
  ?size:int ->
  ?border_radius:int ->
  ?border_color:Draw.color ->
  ?fg:Draw.color ->
  ?bg_on:Style.background ->
  ?bg_off:Style.background ->
  ?bg_over:Style.background option ->
  ?label:Label.t ->
  ?label_on:Label.t ->
  ?label_off:Label.t ->
  ?state:bool ->
  ?action:(bool -> unit) ->
  kind ->
  string ->
  t

The action parameter is executed (with the current button state as argument) just after the button state is modified by mouse clicking or keyboard (on button up or key up). In order to execute an action that depends on the button itself, use Widget.on_button_release instead.

val state : t -> bool

val reset : t -> unit

val is_pressed : t -> bool