diff --git a/doc/events.txt b/doc/events.txt index 92cc6235..4d5a17f3 100644 --- a/doc/events.txt +++ b/doc/events.txt @@ -113,6 +113,27 @@ Description: Open Lua console dialog. +------------------------------------------------------------------------------- +Name: follow-url +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. + +Arguments: + + unsigned char **url, struct session *ses + +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. + ------------------------------------------------------------------------------- Name: free-history Managed By: The scripting subsystem/backends @@ -128,6 +149,24 @@ Description: Allow a subsystem to free its history lists. +------------------------------------------------------------------------------- +Name: get-proxy +Managed By: The scripting subsystem/backends +Triggered When: + + Determining what proxy, if any, should be used to load a requested URL. + +Arguments: + + unsigned char **new_proxy_url, unsigned char *url + +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. + ------------------------------------------------------------------------------- Name: goto-url Managed By: The scripting subsystem/backends @@ -154,45 +193,6 @@ Description: NULL the hook handler should assume no current URI and no suitable UI set up (i.e., starting up yet or -dump). -------------------------------------------------------------------------------- -Name: follow-url -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. - -Arguments: - - unsigned char **url, struct session *ses - -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. - -------------------------------------------------------------------------------- -Name: get-proxy -Managed By: The scripting subsystem/backends -Triggered When: - - Determining what proxy, if any, should be used to load a requested URL. - -Arguments: - - unsigned char **new_proxy_url, unsigned char *url - -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. - ------------------------------------------------------------------------------- Name: periodic-saving Managed By: No maintainer but used by lowlevel/timer.*