/usr/lib/ocaml/eliom/client/eliom_client.mli is in libeliom-ocaml-dev 2.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | (* Ocsigen
* http://www.ocsigen.org
* Module eliom_client.ml
* Copyright (C) 2010 Vincent Balat
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exception;
* either version 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
(** Call server side services and change the current page. *)
open Eliom_lib
(** Call a server side service and change the current page.
If the service belongs to the same application,
the client side program is not stopped, and only
the content (not the container) is reloaded. *)
val change_page :
?absolute:bool ->
?absolute_path:bool ->
?https:bool ->
service:('a, 'b,
[< Eliom_service.service_kind ],
[< `WithSuffix | `WithoutSuffix ], 'd, 'e,
[< Eliom_service.registrable ], Eliom_registration.appl_service)
Eliom_service.service ->
?hostname:string ->
?port:int ->
?fragment:string ->
?keep_nl_params:[ `All | `None | `Persistent ] ->
?nl_params:Eliom_parameter.nl_params_set ->
?keep_get_na_params:bool -> 'a -> 'b -> unit Lwt.t
(** Call a server side service that return an OCaml value. *)
val call_caml_service :
?absolute:bool ->
?absolute_path:bool ->
?https:bool ->
service:('a, 'b,
[< Eliom_service.service_kind ],
[< `WithSuffix | `WithoutSuffix ], 'd, 'e,
[< Eliom_service.registrable ], 'return Eliom_parameter.caml)
Eliom_service.service ->
?hostname:string ->
?port:int ->
?fragment:string ->
?keep_nl_params:[ `All | `None | `Persistent ] ->
?nl_params:Eliom_parameter.nl_params_set ->
?keep_get_na_params:bool -> 'a -> 'b -> 'return Lwt.t
(** Stop current program and load a new page. Note that for string arguments,
sole line feed or sole carriage return characters are substituted by the
string ["\r\n"]. *)
val exit_to :
?absolute:bool ->
?absolute_path:bool ->
?https:bool ->
service:('a, 'b,
[< Eliom_service.service_kind ],
[< `WithSuffix | `WithoutSuffix ], 'd, 'e,
[< Eliom_service.registrable ], [< Eliom_registration.non_caml_service ])
Eliom_service.service ->
?hostname:string ->
?port:int ->
?fragment:string ->
?keep_nl_params:[ `All | `None | `Persistent ] ->
?nl_params:Eliom_parameter.nl_params_set ->
?keep_get_na_params:bool -> 'a -> 'b -> unit
(** Loads an Eliom service in a window (cf. Javascript's [window.open]). *)
val window_open :
window_name:Js.js_string Js.t ->
?window_features:Js.js_string Js.t ->
?absolute:bool ->
?absolute_path:bool ->
?https:bool ->
service:('a, unit,
[< Eliom_service.get_service_kind ],
[< `WithSuffix | `WithoutSuffix ], _, unit,
[< Eliom_service.registrable ], _)
Eliom_service.service ->
?hostname:string ->
?port:int ->
?fragment:string ->
?keep_nl_params:[ `All | `None | `Persistent ] ->
?nl_params:Eliom_parameter.nl_params_set ->
?keep_get_na_params:bool -> 'a -> Dom_html.window Js.t
(** (low level) Call a server side service and return the content
of the resulting HTTP frame as a string. *)
val call_service :
?absolute:bool ->
?absolute_path:bool ->
?https:bool ->
service:('a, 'b,
[< Eliom_service.service_kind ],
[< `WithSuffix | `WithoutSuffix ], 'd, 'e,
[< Eliom_service.registrable ], 'return)
Eliom_service.service ->
?hostname:string ->
?port:int ->
?fragment:string ->
?keep_nl_params:[ `All | `None | `Persistent ] ->
?nl_params:Eliom_parameter.nl_params_set ->
?keep_get_na_params:bool -> 'a -> 'b -> string Lwt.t
(** wait for the loading phase to terminate *)
val wait_load_end : unit -> unit Lwt.t
(** true if the function is executed inside the loading phase *)
val in_onload : unit -> bool
(** register a function to be called on page change *)
val on_unload : (unit -> unit) -> unit
(**/**)
val relink_request_nodes : Dom_html.htmlElement Js.t -> unit
val reset_request_node : unit -> unit
val load_eliom_data :
Eliom_types.eliom_js_page_data ->
Dom_html.htmlElement Js.t -> (Dom_html.event Js.t -> bool) list
val register_closure: int64 -> ('a -> Dom_html.event Js.t -> unit) -> unit
val getElementById : string -> Dom.node Js.t
val rebuild_node : 'a Eliom_content_core.Html5.elt -> < .. > Js.t
|