package stk

You can search for identifiers within the package.

in-package search v0.2.0

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

Logging.

Stk uses a Logs.Src.t whose log functions are available in this module. Some modules also uses their own Logs.Src.t (like Textview or Textbuffer).

At load time, the environment variable STK_lOG_LEVEL is read to initialize the log level of log_src. Default is Logs.warning.

The create_src function creates a new log source whose messages are tagged with the "stk" tag. This is useful to separate Stk log messages from other log messages, as stk log messages should not be displayed in the Gui (this could cause some infinite loop). The creation of a new log source reads the corresponding environment variable to initialize the log level of the new source. For example, !create_src "stk.foo" will create a new log source and whose level will be initialized by looking at the STK_FOO_LOG_LEVEL.

Textlog module provides a Logs.reporter to dispatch messages based on the tags attached to the message.

val tag : unit Logs.Tag.def

Tag for Stk log messages.

module type LOG = sig ... end

val create_src : ?doc:'a -> string -> (module LOG)

include LOG

val log_src : Logs.Src.t

include Logs.LOG

val msg : Logs.level -> 'a Logs.log

val app : 'a Logs.log

val err : 'a Logs.log

val warn : 'a Logs.log

val info : 'a Logs.log

val debug : 'a Logs.log

val kmsg : (unit -> 'b) -> Logs.level -> ('a, 'b) Logs.msgf -> 'b

val on_error : 
  ?level:Logs.level ->
  ?header:string ->
  ?tags:Logs.Tag.set ->
  pp:(Stdlib.Format.formatter -> 'b -> unit) ->
  use:('b -> 'a) ->
  ('a, 'b) Stdlib.result ->
  'a

val on_error_msg : 
  ?level:Logs.level ->
  ?header:string ->
  ?tags:Logs.Tag.set ->
  use:(unit -> 'a) ->
  ('a, [ `Msg of string ]) Stdlib.result ->
  'a

val src_list : unit -> Logs.src list

The list of stk log sources (i.e. the log sources created by create_src).