package chamo

  1. Overview
  2. Docs
package chamo
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Chamo.GuiSource

The main GUI module, defining windows and boxes used to split the windows.

More elements can be showed in interface if needed.

Sourceclass gui_window : ?x:int -> ?y:int -> ?w:int -> ?h:int -> unit -> object ... end
Sourceclass gui_paned : View.topwin -> Stk.Props.orientation -> unit -> object ... end
Sourceclass gui_notebook : View.topwin -> unit -> object ... end
Sourceval init_view : View.topwin -> View.gui_view -> unit

This function inits a view with the given window.

Sourcetype gui_windows = gui_window list
Sourceval gui_windows : gui_windows ref
Sourceval active_window : gui_window option ref
Sourceval on_last_window_close : (unit -> unit) ref

The default function does nothing. the referenced function is called when the last gui window is dsetroyed.

Sourceval create_window : ?x:int -> ?y:int -> ?w:int -> ?h:int -> unit -> gui_window
Sourceval in_new_window : string array -> unit

Code of the "in_new_window" command which creates a new window and use it as active window when evaluating the command represented by the given arguments: first argument is the command name, following ones are the arguments of the command to launch.

Sourceval on_active_window : (gui_window -> unit) -> unit -> unit

This function, on_active_window_lwt and on_active_window_args can be used to apply a function to the active window, if any. They are useful when creating commands to register.

Sourceval on_active_window_lwt : (gui_window -> unit Lwt.t) -> unit -> unit Lwt.t
Sourceval on_active_window_args : (gui_window -> string array -> unit) -> string array -> unit Lwt.t
Sourceval prompt_command_history : Minibuffer.minibuffer_history

The history associated to the "prompt_command" command.

Sourceval prompt_command : gui_window -> unit

This function uses the active window's minibuffer to prompt the user for a command.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct