package bogue

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

One-line text widget

A Label is a widget for displaying a single line of text.

type t

type font

val create : 
  ?size:int ->
  ?font:font ->
  ?style:Tsdl_ttf.Ttf.Style.t ->
  ?fg:Draw.color ->
  string ->
  t

Create a new Label.t. Most of the time, you'd rather want to create a Widget.t by using Widget.label.

val icon : ?size:int -> ?fg:Draw.color -> string -> t

Create a Label.t using the name of a FontAwesome symbol. Most of the time, you'd rather want to create a Widget.t by using Widget.icon.

val set : t -> string -> unit

Modify the text of the label.

val set_fg_color : t -> Draw.color -> unit

Modify the color of the text.

val size : t -> int * int

Return the logical size (w,h). Warning, a +/- 1 error can be observed due to rounding.