Button (u.889b57e779d02bfcd2617a974df88c63.stk.0.3.0.doc.stk.Stk.Button)

Sourceval active : bool Props.prop

Property used to indicate whether a toggle or option button is activate.

Simple buttons

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

Simple button.

Source

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

Convenient function to create a button. See Widget arguments for arguments.

Source

val text_button : 
  ?classes:string list ->
  ?label_classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?text:string ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  button * Text.label

Convenient function to create a button with a Text.label as child. text optional argument is passed to Text.label. label_class is passed as ?class_ argument when creating label. See Widget arguments for other arguments.

Toggle buttons

Source

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

A toggle button. State is represented by the active property. Activating the widget toggles the state.

Source

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

Convenient function to create a togglebutton. Initial state can be specifier with the active argument (default is false). See Widget arguments for other arguments.

Source

val text_togglebutton : 
  ?classes:string list ->
  ?label_classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?active:bool ->
  ?text:string ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  togglebutton * Text.label

Convenient function to create a togglebutton with a Text.label as child. Initial state can be specifier with the active argument (default is false). text optional argument is passed to Text.label. label_class is passed as ?class_ argument when creating label. See Widget arguments for other arguments.

Check and radio buttons

Sourceclass group : object ... end

A group is used to share a state among several checkbuttons, so they act as radio buttons (only one can be active at the same time).

Sourceval group : unit -> group

Convenient function to create a group.

The following properties are used to tune the appearance of checkbuttons: a font and active and inactive characters.

Sourceval check_indicator_font : Font.font_desc Props.prop

Sourceval css_check_indicator_font : Font.font_desc Css.P.prop

Sourceval check_indicator_active_char : Uchar.t Props.prop

Sourceval css_check_indicator_active_char : Uchar.t Css.P.prop

Sourceval check_indicator_inactive_char : Uchar.t Props.prop

Sourceval css_check_indicator_inactive_char : Uchar.t Css.P.prop

Source

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

The checkbutton widget.

Source

val checkbutton : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?active:bool ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  checkbutton

Convenient function to create a checkbutton. Initial state can be specifier with the active argument (default is false). See Widget arguments for other arguments.

Source

val radiobutton : 
  ?classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?active:bool ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  checkbutton

Convenient function to create a checkbutton acting as a radio button (with class "radiobutton"). Initial state can be specifier with the active argument (default is false). group can be used to set the group the radio button belongs to. See Widget arguments for other arguments.

Source

val text_checkbutton : 
  ?classes:string list ->
  ?label_classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?active:bool ->
  ?text:string ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  checkbutton * Text.label

Convenient function to create a checkbutton with a Text.label as child. Initial state can be specifier with the active argument (default is false). text optional argument is passed to Text.label. label_classes is passed as ?classes argument when creating label. See Widget arguments for other arguments.

Source

val text_radiobutton : 
  ?classes:string list ->
  ?label_classes:string list ->
  ?name:string ->
  ?props:Props.t ->
  ?wdata:Widget.wdata ->
  ?group:group ->
  ?active:bool ->
  ?text:string ->
  ?pack:(Widget.widget -> unit) ->
  unit ->
  checkbutton * Text.label

Convenient function to create a checkbutton acting as a radio button (with class "radiobutton") with a Text.label as child. Initial state can be specifier with the active argument (default is false). group can be used to set the group the radio button belongs to. text optional argument is passed to Text.label. label_classes is passed as ?classes argument when creating label. See Widget arguments for other arguments.