package stk

  1. Overview
  2. Docs
SDL-based GUI toolkit

Install 

dune-project
 Dependency

zoggy.frama.io Readme Edit opam file Versions (5)

Authors

  1. Z
    Zoggy <zoggy@bat8.org>

Maintainers

  1. Z
    zoggy@bat8.org

Sources

ocaml-stk-0.5.0.tar.bz2
md5=beeed5752ff67b3abeb1bcf8fb6b9098
sha512=c1603ae66956a674864ad875212fdbfc8d8016983202108d492b0d8722106b1e982e9fdc04b20d1b7adf5013343252fc5173851751906271731bc81d70dc789c

doc/stk/Stk/Paned/index.html

Module Stk.PanedSource

Paned widgets.

Sourcetype handle_position = [
  1. | `Percent of float
  2. | `Absolute of int
]

A handle position, defined either as percentage or absolute position.

Sourceval handle_position_wrapper : [ `Absolute of int | `Percent of float ] Ocf.Wrapper.t
Sourceval handle_positions : handle_position option list Props.prop

Property "handle_positions", to store the positions of the handles in a paned widget.

Sourceval css_handle_positions_prop : ?inherited:bool -> ?def:[ `Absolute of int | `Percent of float ] option list -> [ `Absolute of int | `Percent of float ] option list Props.prop -> [ `Absolute of int | `Percent of float ] option list Css.P.prop
Sourceval css_handle_positions : handle_position option list Css.P.prop
Sourcetype user_handle_positionning = [
  1. | `Percent
  2. | `Absolute
]

How to define handle position when the user moves it: as percentage or absolute value. This changes the way handle positions are updated when the paned widget is resized: with `Percent, ratios between children will be kept, but with `Absolute the handles will remain at the same position.

Sourceval user_handle_positionnings : [> `Absolute | `Percent ] list
Sourceval string_of_user_handle_positionning : [< `Absolute | `Percent ] -> string
Sourceval user_handle_positionning_of_string : string -> [ `Absolute | `Percent ] option
Sourceval user_handle_positionning_wrapper : user_handle_positionning Ocf.wrapper
Sourceval user_handle_positionning : user_handle_positionning Props.prop

Property "user_handle_positionning".

Sourceval css_user_handle_positioning_prop : ?inherited:bool -> ?def:[ `Absolute | `Percent ] -> [ `Absolute | `Percent ] Props.prop -> [ `Absolute | `Percent ] Css.P.prop
Sourceval css_user_handle_positioning : user_handle_positionning Css.P.prop
Sourceval handle_props : Props.t Props.prop

Property "paned_handle_props" to define appearance of handles in paned widget. Default set Props.width to 2 and Props.fg_color to Color.grey.

Sourceval user_set_handle_live_update : bool Props.prop

Property "paned_user_set_handle_live_update" defines whether to update paned widget on each move of a handle by user (true), or wait for the user to end moving the handle (false). Default is true. It may be useful to set it to false when computation of children sizes may take some time.

Sourceval css_user_set_handle_live_update : bool Css.P.prop
Sourceclass paned : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata: Widget.wdata option -> unit -> object ... end

Paned widget.

Sourcetype Widget.widget_type +=
  1. | Paned of paned
Sourceval paned : Props.orientation -> ?classes:string list -> ?name:string -> ?user_set_handle_live_update:bool -> ?props:Props.t -> ?wdata:Widget.wdata -> ?pack:(Widget.widget -> unit) -> unit -> paned
Sourceval hpaned : ?classes:string list -> ?name:string -> ?user_set_handle_live_update:bool -> ?props:Props.t -> ?wdata:Widget.wdata -> ?pack:(Widget.widget -> unit) -> unit -> paned
Sourceval vpaned : ?classes:string list -> ?name:string -> ?user_set_handle_live_update:bool -> ?props:Props.t -> ?wdata:Widget.wdata -> ?pack:(Widget.widget -> unit) -> unit -> paned