Module Stk.ScrollboxSource

Scrollboxes.

Sourcetype Events.ev +=
  1. | HScrolled : (unit -> unit) Events.ev
  2. | VScrolled : (unit -> unit) Events.ev
Sourcetype scrollbar_policy = [
  1. | `ALWAYS
  2. | `NEVER
  3. | `AUTOMATIC
  4. | `NOSCROLL
]

Policy for scrollbars:

  • `ALWAYS: always displays scrollbar, even when not needed.
  • `NEVER: never displays scrollbar, even when needed.
  • `AUTOMATIC: displays scrollbar only when needed, i.e. when child content is larger than the scrollbox in the considered direction (horizontal or vertical).
  • `NOSCROLL: do not scroll, constraint child with available width or height.
Sourceval scrollbar_policies : [> `ALWAYS | `AUTOMATIC | `NEVER | `NOSCROLL ] list
Sourceval string_of_scrollbar_policy : scrollbar_policy -> string
Sourceval scrollbar_policy_of_string : string -> scrollbar_policy option
Sourceval scrollbar_policy_wrapper : scrollbar_policy Ocf.Wrapper.t

Ocf wrapper for scrollbar_policy.

Sourcemodule TScrollbar_policy : sig ... end
Sourcemodule PScrollbar_policy : sig ... end
Sourceval scrollbar_policy_prop : scrollbar_policy Props.mk_prop
Sourceval css_scrollbar_policy_prop : ?inherited:bool -> ?def:scrollbar_policy -> scrollbar_policy Props.prop -> scrollbar_policy Css.P.prop
Sourceval hscrollbar_policy : scrollbar_policy Props.prop
Sourceval css_hscrollbar_policy : scrollbar_policy Css.P.prop
Sourceval vscrollbar_policy : scrollbar_policy Props.prop
Sourceval css_vscrollbar_policy : scrollbar_policy Css.P.prop
Sourceval hscrollbar_covers_child : bool Props.prop
Sourceval css_hscrollbar_covers_child : bool Css.P.prop
Sourceval vscrollbar_covers_child : bool Props.prop
Sourceval css_vscrollbar_covers_child : bool Css.P.prop
Sourceclass scrollbox : ?classes:string list option -> ?name:string option -> ?props:Props.t option -> ?wdata: Widget.wdata option -> unit -> object ... end

Scrollbox widget.

Sourcetype Widget.widget_type +=
  1. | Scrollbox of scrollbox
Sourceval scrollbox : ?classes:string list -> ?name:string -> ?props:Props.t -> ?wdata:Widget.wdata -> ?hpolicy:scrollbar_policy -> ?vpolicy:scrollbar_policy -> ?hcovers_child:bool -> ?vcovers_child:bool -> ?pack:(Widget.widget -> unit) -> unit -> scrollbox

Convenient function to create a scrollbox. hpolicy and vpolicy optional arguments specify horizontal and vertical scrollbar policies. See Widget arguments for other arguments.