Module Bogue.Label

module Label: sig .. end

One-line text widget.

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

Dependency graph

type t

type font

type style = Tsdl_ttf.Ttf.Style.t

See Ttf.Style.

val create : ?size:int ->
       ?font:font ->
       ?style:style ->
       ?fg:Draw.color -> ?align:Draw.align -> 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 font_from_file : string -> font

Define a font by specifying a filename of a TTF file. The font will be loaded only when needed. A caching mechanism avoids loading the same font several times. If you need to find a font from the theme (or system) directory, see Theme.get_font_path_opt.

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. Does nothing if the given text is already the same as the label's previous text.

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.