Index of class methods

A
add_lazy_var_function [Wd_types.application_type]	Adds a variable function with lazy evaluation of its arguments
add_output_encoding [Wd_types.application_type]	Adds the output encoding function (second argument) under the passed name (first argument) to the application.
add_var_function [Wd_types.application_type]	Adds a variable function with eager evaluation
alist_variable [Wd_types.dialog_type]	`alist_variable n`: Get the contents of the associative variable `n`.
application [Wd_types.universe_type]	Return the application this universe is made for
application [Wd_types.dialog_type]	Return the application
C
change_dialog [Wd_types.session_type]	Continue with a new dialog.
charset [Wd_types.application_type]	Returns the character set used for the internal representation, and for the generated HTML pages.
commit_changes [Wd_types.session_type]	Causes that `serialize` returns the current state of the dialog.
copy [Wd_types.dialog_type]	return a copy of the dialog
create [Wd_types.universe_type]	Creates a new object for the passed environment and dialog name.
create [Wd_types.session_manager_type]	Creates a new session for this dialog
D
debug_mode [Wd_types.application_type]	Returns whether there is a processing instruction `<?wd-debug-mode?>`.
debug_mode_style [Wd_types.application_type]	Returns the style of the debug mode
declaration [Wd_types.dialog_type]	Return the declaration of this dialog
default_context [Wd_types.dialog_decl_type]	Returns the default context of the dialog, i.e.
dialog [Wd_types.session_type]	Returns the dialog
dialog_declaration [Wd_types.application_type]	Returns the declaration for the passed dialog
dialog_name [Wd_types.session_type]	Returns the name of the dialog this session encapsulates
dialog_names [Wd_types.application_type]	Returns the names of the declared dialogs
dialog_variable [Wd_types.dialog_type]	`dialog_variable n`: Get the contents of the dialog variable `n`.
dtd [Wd_types.application_type]	Returns the DTD of WDialog
dump [Wd_types.dialog_type]	`dump f` output a textual description of the current state into formatter `f`.
dyn_enum_variable [Wd_types.dialog_type]	`dyn_enum_variable n`: Get the contents of the enumerator variable `n`.
E
enter_session_scope [Wd_types.dialog_type]	Tells the dialog the current session
enum_variable [Wd_types.dialog_type]	`enum_variable n`: Get the contents of the enumerator variable `n`.
enumeration [Wd_types.dialog_decl_type]	Returns the declared enumeration
environment [Wd_types.dialog_type]	Return the environment of the current CGI activation
escaped_data [Wd_types.syntax_tree_type]	Returns the string contained in the data node after HTML-escaping has been applied.
event [Wd_types.dialog_type]	returns the event that just has happened
H
handle [Wd_types.dialog_type]	This method is invoked just after the user triggered an event (e.g.
I
instantiate [Wd_types.template_type]	Instantiates the template.
is_server_popup_request [Wd_types.dialog_type]	Returns whether someone invoked `set_server_popup_request` before.
L
language_variable [Wd_types.dialog_decl_type]	Returns `Some v` if a language variable called `v` is declared, or `None` if no such variable exists.
lazy_var_function [Wd_types.application_type]	Returns the variable function as O'Caml function
leave_session_scope [Wd_types.dialog_type]	Tells the dialog that it is no longer under control of this session
lookup_dialog_variable [Wd_types.dialog_type]	`lookup_`*`_variable n x`: Get the contents of the associative variable `n` at index `x`.
lookup_dyn_enum_variable [Wd_types.dialog_type]
lookup_enum_variable [Wd_types.dialog_type]
lookup_string_variable [Wd_types.dialog_type]
lookup_uploaded_file [Wd_types.dialog_type]	`lookup_uploaded_file name`: Checks whether the file upload box `name` was used.
N
name [Wd_types.dialog_type]	return the name of the dialog
name [Wd_types.dialog_decl_type]	The name of the dialog
next_page [Wd_types.dialog_type]	Returns the name of the designated next page.
O
onstartup_call_handle [Wd_types.application_type]	Returns whether there is a processing instruction `<?wd-onstartup-call-handle?>`.
output_encoding [Wd_types.application_type]	Returns the output encoding as function `string -> string`
P
page [Wd_types.dialog_decl_type]	Returns the XML tree of the demanded page (i.e.
page_is_declared_as_popup [Wd_types.dialog_decl_type]	Returns whether the page is declared as popup page (attribute `popup`
page_name [Wd_types.dialog_type]	return the name of the current page
page_names [Wd_types.dialog_type]	returns the names of all defined pages of this dialog
page_names [Wd_types.dialog_decl_type]	Returns the names of all declared pages
prepare_page [Wd_types.dialog_type]	This method is invoked just before a new output page is generated.
prototype_mode [Wd_types.application_type]	Returns whether there is a processing instruction `<?wd-prototype-mode?>`.
put_tree [Wd_dialog.dialog]	Sets the `string` variable to the string representation of the `tree`
R
register [Wd_types.universe_type]	Registers that a certain O'Caml class implements the callbacks of the dialog declared in the UI definition.
S
scan_application [Wd_types.syntax_tree_type]	Scanner methods
scan_dialog [Wd_types.syntax_tree_type]
scan_enumeration [Wd_types.syntax_tree_type]
scan_literal [Wd_types.syntax_tree_type]	(But this one is functional)
serialize [Wd_types.session_type]	Returns the state of the dialog at the time of the last `commit_change` or the state of the initial dialog
serialize [Wd_types.dialog_type]	Writes the state of this dialog into the buffer.
session [Wd_types.dialog_type]	Returns the current session.
session_id [Wd_types.session_type]	Returns the ID of the session.
set_next_page [Wd_types.dialog_type]	Sets the name of the designated next page
set_variable [Wd_types.dialog_type]	`set_variable n v`: Sets the variable `n` to the value `v`.
start_dialog_name [Wd_types.application_type]	Returns the name of the start dialog
start_page [Wd_types.dialog_decl_type]	Returns the name of the start page
string_variable [Wd_types.dialog_type]	`string_variable n`: Get the contents of the string variable `n`.
study [Wd_types.template_type]	Studies the template for the scope of the passed application
study [Wd_types.application_type]	Studies all defined templates
T
t_apply [Wd_dialog.dialog]	Applies the template, and passes the parameters to it
t_apply_byname [Wd_dialog.dialog]	Applies the named template, and passes the parameters to it
t_apply_lazily [Wd_dialog.dialog]	Constructs the expression that applies the names template on demand.
t_concat [Wd_dialog.dialog]	Concatenates the `tree list`, and put the separator `tree` between the parts
t_empty [Wd_dialog.dialog]	The empty XML tree
t_get [Wd_dialog.dialog]	Returns the template
t_html [Wd_dialog.dialog]	The XML tree containing this HTML material
t_text [Wd_dialog.dialog]	The XML tree containing this text
t_to_string [Wd_dialog.dialog]	Evaluates the XML tree in the current environment, and returns the corresponding output string (HTML code)
template [Wd_types.application_type]	Returns the definition of the passed template
template_names [Wd_types.application_type]	Returns the names of the declared templates (including the templates of the core and the standard libraries)
to_html [Wd_types.syntax_tree_type]	This method writes the current node and all its children to the passed output channel.
to_text [Wd_types.syntax_tree_type]	This method writes the current node and all its children to the passed output channel.
U
universe [Wd_types.dialog_type]	Return the universe
unserialize [Wd_types.dialog_type]	Sets the state of this dialog from the deserialization buffer which must contain previously serialized dialog.
unserialize [Wd_types.session_manager_type]	Restores an old session for the passed universe and the passed environment.
unset_variable [Wd_types.dialog_type]	`unset_variable n`: Sets the variable `n` to the declared default value.
V
var_function [Wd_types.application_type]	Returns the variable function as O'Caml function.
variable [Wd_types.dialog_type]	`variable n`: Get the variable with name `n`, or raise `No_such_variable`.
variable [Wd_types.dialog_decl_type]	Returns a single variable declaration
variable_decl [Wd_types.dialog_type]
variable_names [Wd_types.dialog_decl_type]	Returns the names of all declared variables

This web site is published by Informatikbüro Gerd Stolpmann

Plasma	GitLab	Archive
Projects	Blog	Knowledge