package stk

You can search for identifiers within the package.

in-package search v0.2.0

package stk

stk
- Stk
  - App
  - Bin
    
    PScrollbar_policy
    
    TScrollbar_policy
    
    bin
    
    event_box
    
    fixed_size
    
    scrollbox
  - Button
    
    button
    
    checkbutton
    
    group
    
    togglebutton
  - Canvas
    
    box
    
    canvas
    
    container_item
    
    fixed_size
    
    flex
    
    full_item
    
    glyph
    
    group
    
    item
    
    label
    
    paned
    
    rect
  - Clist
    
    cell
    
    cell_
    
    clist
    
    label_cell
    
    text_cell
  - Color
  - Container
    
    container
  - Default_app
    
    app
  - Dialog
    
    dialog
  - Edit
    
    entry
  - Events
  - Flex
    
    flex
    
    space
  - Fmts
  - Font
  - Frame
    
    frame
  - G
  - Image
    
    image
  - Key
  - Layer
    
    Map
    
    Ord
  - Log
    
    LOG
  - Menu
    
    menu
    
    menubar
    
    menuitem
  - Misc
    
    Base_id
    
    IMap
    
    ISet
    
    Id
    
    Idset
    
    I
    
    SMap
  - Notebook
    
    notebook
  - Object
    
    o
  - Oid
    
    I
  - Pack
    
    box
    
    paned
  - Packer
  - Props
    
    Add_prop_type
    
    T
    
    Id
    
    PBool
    
    PColor
    
    PFloat
    
    PFont_desc
    
    PInt
    
    PLayer
    
    PPair
    
    T1
    
    T2
    
    PPair_float
    
    PProps
    
    PString
    
    PT
    
    PTrbl
    
    T
    
    PTrbl_color
    
    PTrbl_int
    
    PUchar
    
    Prop_type
    
    TColor
    
    TInt
    
    TProps
  - Range
    
    range
  - Render
  - Rope
  - Selection
  - Text
    
    Status_msg_id
    
    glyph
    
    label
    
    status
    
    textured_glyph
    
    textured_text
  - Textbuffer
  - Textlog
    
    textlog
  - Texttag
    
    Lang
    
    T
    
    TSet
    
    Theme
  - Texture
  - Textview
    
    textview
  - Theme
  - Tree
    
    IMap
    
    ISet
    
    Id
    
    tree
  - Utf8
  - Widget
    
    Map
    
    Set
    
    widget
  - Window
    
    window
  - Wkey

Legend:
Library
Module
Module type
Parameter
Class
Class type

Geometry.

This module is used to represent and compute widget coordinates.

type t = {

x : int;
y : int;
w : int;
(*
width
*)
h : int;
(*
height
*)

}

A geometry is rectangle. x and y are coordinates of top-left corner.

val to_string : t -> string

val pp : Stdlib.Format.formatter -> t -> unit

val create : x:int -> y:int -> w:int -> h:int -> t

Convenient function to create a t.

val seg_inter : int -> int -> int -> int -> (int * int) option

seg_inter x1 w1 x2 w2 returns the intersection segment (left..right) between segments (x1..(x1+w1)) and (x2..(x2+w2)), if any.

val inter : t -> t -> t option

Intersection between two rectangles, if any.

val union : t -> t -> t

Union of two rectangles, i.e. returns the rectangle containing both.

val zero : t

Zero geometry, all fields set to 0.

val is_zero : t -> bool

val inside : x:int -> y:int -> t -> bool

inside ~x ~y g returns true is point (x, y) is inside g.

val translate : ?x:int -> ?y:int -> t -> t

translate ~x ~y g returns a new geometry, adding x (resp. y) to g.x (resp. g.y) if specified.

val enlarge : ?w:int -> ?h:int -> t -> t

enlarge ~w ~h g returns a new geometry whose width (resp. height) is increased by 2 * w (resp. 2 * h). g.x (resp. g.y) is translated by -w (resp. -h) so that the final geometry remains centered with report to the original one.

val to_rect : t -> Tsdl.Sdl.rect

to_rect g creates a Tsdl.Sdl.rect from g.

val of_rect : Tsdl.Sdl.rect -> t

of_rect r creates a geometry t from a Tsdl.Sdl.rect.

val has_intersect : t -> t -> bool

has_intersect g1 g2 returns true if intersection g1 g2 <> None.

val remove_border : t -> int Props.trbl -> t

remove_border g borders returns a new geometry by removing borders from g. It is ensured that the returned geometry has non-negative width and height.