package eliom

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

Module Eliom_content.XmlSource

Low-level XML manipulation.

Base functions

See <<a_api project="tyxml" | module Xml_sigs.Iterable >> .

include Xml_sigs.Iterable with type 'a wrap = 'a and type 'a list_wrap = 'a list and type event_handler = (Js_of_ocaml.Dom_html.event Js_of_ocaml.Js.t -> unit) Eliom_client_value.t and type mouse_event_handler = (Js_of_ocaml.Dom_html.mouseEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t and type keyboard_event_handler = (Js_of_ocaml.Dom_html.keyboardEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t and type touch_event_handler = (Js_of_ocaml.Dom_html.touchEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t
module W : sig ... end
Sourcetype !'a wrap = 'a
Sourcetype !'a list_wrap = 'a list
Sourcetype uri
Sourceval string_of_uri : (uri, string) W.ft
Sourceval uri_of_string : (string, uri) W.ft
Sourcetype aname = string
Sourcetype event_handler = (Js_of_ocaml.Dom_html.event Js_of_ocaml.Js.t -> unit) Eliom_client_value.t
Sourcetype mouse_event_handler = (Js_of_ocaml.Dom_html.mouseEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t
Sourcetype keyboard_event_handler = (Js_of_ocaml.Dom_html.keyboardEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t
Sourcetype touch_event_handler = (Js_of_ocaml.Dom_html.touchEvent Js_of_ocaml.Js.t -> unit) Eliom_client_value.t
Sourcetype attrib
Sourceval float_attrib : aname -> float wrap -> attrib
Sourceval int_attrib : aname -> int wrap -> attrib
Sourceval string_attrib : aname -> string wrap -> attrib
Sourceval space_sep_attrib : aname -> string list wrap -> attrib
Sourceval comma_sep_attrib : aname -> string list wrap -> attrib
Sourceval event_handler_attrib : aname -> event_handler -> attrib
Sourceval mouse_event_handler_attrib : aname -> mouse_event_handler -> attrib
Sourceval keyboard_event_handler_attrib : aname -> keyboard_event_handler -> attrib
Sourceval touch_event_handler_attrib : aname -> touch_event_handler -> attrib
Sourceval uri_attrib : aname -> uri wrap -> attrib
Sourceval uris_attrib : aname -> uri list wrap -> attrib
Sourcetype elt
Sourcetype ename = string
Sourceval empty : unit -> elt
Sourceval comment : string -> elt
Sourceval pcdata : string wrap -> elt
Sourceval encodedpcdata : string wrap -> elt
Sourceval entity : string -> elt
Sourceval leaf : ?a:attrib list -> ename -> elt
Sourceval node : ?a:attrib list -> ename -> elt list_wrap -> elt
Sourceval cdata : string -> elt
Sourceval cdata_script : string -> elt
Sourceval cdata_style : string -> elt
Sourcetype separator =
  1. | Space
  2. | Comma
Sourceval aname : attrib -> aname
Sourcetype acontent = private
  1. | AFloat of float
  2. | AInt of int
  3. | AStr of string
  4. | AStrL of separator * string list
Sourceval acontent : attrib -> acontent
Sourcetype econtent = private
  1. | Empty
  2. | Comment of string
  3. | EncodedPCDATA of string
  4. | PCDATA of string
  5. | Entity of string
  6. | Leaf of ename * attrib list
  7. | Node of ename * attrib list * elt list
Sourceval content : elt -> econtent

Unique nodes

Unique nodes are XML nodes that are manipulated 'by reference' when sent to the client part of an Eliom-application: the created element is allocated only one time in each instance of an application. See <<a_manual chapter="clientserver-html" fragment="unique" |the eliom manual>> for more details.

Event handlers

Sourcetype caml_event_handler

Values of type caml_event_handler represents event handler build with the {{ ... }} syntax (see the Eliom manual for more information on <<a_manual chapter="clientserver-html" fragment="syntax"|syntax extension>>). Such values are expected by functions like Eliom_content.Html.a_onclick.

Sourceval wrap : elt -> 'a -> 'a Eliom_wrap.wrapped_value

Eliom_content.Xml.wrap page v is like Eliom_wrap.wrap v but it makes sure that all elts in v which are included in page are sent with empty content. This is safe because such elements will be taken from the DOM on the client either ways.

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