Functions

Summary

Controls a browser-pane.

Signature

browser-pane-navigate pane url => result

browser-pane-busy pane => result

browser-pane-go-back pane

browser-pane-go-forward pane

browser-pane-set-content pane string

browser-pane-stop pane

browser-pane-refresh pane &optional level

Arguments

pane

A browser-pane.

url

A string.

string

A string.

level

One of the keywords :normal and :refresh_completely.

Values

result

A boolean.

name

A string.

Description

These functions are used to control an instance of browser-pane.

browser-pane-navigate navigates to the supplied URL, that is it gets and displays the contents of the URL. Note that if there is any redirection, it is the redirected URL that is displayed.

browser-pane-navigate does the navigation asynchronously, so when the function returns the navigation has just started. If result is true then the navigation started, and if result is nil then some error in the URL has already been detected. If the pane has an error callback, it already has been called in this case.

If browser-pane-navigate is called while pane is not displayed, it sets the initial URL of it.

Note: browser-pane-navigate can be used to effect a redirection from inside the error before navigation and new-window callbacks.

browser-pane-busy tests whether the browser is currently navigating, returning true if it is.

browser-pane-go-forward and browser-pane-go-back navigate forward and back in the history, like the buttons on most web browsers.

browser-pane-set-content sets the contents of pane to string . It has same effect as if pane navigated to a URL whose contents is string . browser-pane-set-content creates a temporary file containing string and uses the pathname as the URL for pane . The file is deleted when pane is destroyed.

browser-pane-stop stops the current navigation.

browser-pane-refresh refreshes the pane, which means re-reading the URL. level can be one of:

:normal

Asks the server for the contents again. This is the default value of level .

:refresh_completely

Asks the server for the contents again without looking at any cache (it uses header Pragma:no-cache).

Notes

browser-pane and related APIs are implemented on Microsoft Windows and Cocoa only.

Compatibility note

In LispWorks 6.1 these functions were documented as generic functions, however it is not intended that you should define methods.

See also

browser-pane