From 538e8eb8a51fddc93ef952704f33b8efa518efa6 Mon Sep 17 00:00:00 2001 From: Kalle Olavi Niemitalo Date: Mon, 25 Sep 2006 22:46:48 +0300 Subject: [PATCH] List events in alphabetical order. --- doc/events.txt | 72 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/doc/events.txt b/doc/events.txt index 92cc6235..4d5a17f3 100644 --- a/doc/events.txt +++ b/doc/events.txt @@ -114,84 +114,84 @@ Description: Open Lua console dialog. ------------------------------------------------------------------------------- -Name: free-history +Name: follow-url Managed By: The scripting subsystem/backends Triggered When: - ELinks exits + The user decides to load some document by following a link, entering an URL + in the goto URL dialog, loading frames from a frameset (?) etc. Arguments: - None + unsigned char **url, struct session *ses Description: - Allow a subsystem to free its history lists. + If another URL than @url should be followed it is passed by setting @url. + If @url is changed the event propagation should be ended. + Valid values for @url includes: + - leaving @url unchanged if the original URL should be followed; + - NULL if no URL should be followed; or + - a dynamically allocated new URL to be followed instead. ------------------------------------------------------------------------------- -Name: goto-url +Name: free-history Managed By: The scripting subsystem/backends Triggered When: - The user enters something into the goto URL dialog. + ELinks exits Arguments: - unsigned char **url, struct session *ses + None Description: - If a URL other than @url should be followed, the old one should be freed - and the new one should be assigned to @url. @url must not be assigned - NULL and must remain freeable. - Valid values for @url are: - - unchanged, if the original URL should be followed; - - a new, dynamically allocated URL to be followed instead; or - - an empty string, if no URL should be followed. - - @ses is usually used for deciding based on the current URI or for reporting - potential errors during the hook processing through the UI. With @ses being - NULL the hook handler should assume no current URI and no suitable UI set up - (i.e., starting up yet or -dump). + Allow a subsystem to free its history lists. ------------------------------------------------------------------------------- -Name: follow-url +Name: get-proxy Managed By: The scripting subsystem/backends Triggered When: - The user decides to load some document by following a link, entering an URL - in the goto URL dialog, loading frames from a frameset (?) etc. + Determining what proxy, if any, should be used to load a requested URL. Arguments: - unsigned char **url, struct session *ses + unsigned char **new_proxy_url, unsigned char *url Description: - If another URL than @url should be followed it is passed by setting @url. - If @url is changed the event propagation should be ended. - Valid values for @url includes: - - leaving @url unchanged if the original URL should be followed; - - NULL if no URL should be followed; or - - a dynamically allocated new URL to be followed instead. + Possible values for @new_proxy_url includes: + - a dynamically allocated string with the format proxy:port; + - an empty string (dynamically allocated!) to use no proxy; or + - NULL to use the default proxies. ------------------------------------------------------------------------------- -Name: get-proxy +Name: goto-url Managed By: The scripting subsystem/backends Triggered When: - Determining what proxy, if any, should be used to load a requested URL. + The user enters something into the goto URL dialog. Arguments: - unsigned char **new_proxy_url, unsigned char *url + unsigned char **url, struct session *ses Description: - Possible values for @new_proxy_url includes: - - a dynamically allocated string with the format proxy:port; - - an empty string (dynamically allocated!) to use no proxy; or - - NULL to use the default proxies. + If a URL other than @url should be followed, the old one should be freed + and the new one should be assigned to @url. @url must not be assigned + NULL and must remain freeable. + Valid values for @url are: + - unchanged, if the original URL should be followed; + - a new, dynamically allocated URL to be followed instead; or + - an empty string, if no URL should be followed. + + @ses is usually used for deciding based on the current URI or for reporting + potential errors during the hook processing through the UI. With @ses being + NULL the hook handler should assume no current URI and no suitable UI set up + (i.e., starting up yet or -dump). ------------------------------------------------------------------------------- Name: periodic-saving -- 2.11.4.GIT