Command: wweb

Syntax

{ <window> = } wweb { <url> }

Description

Define a window for web browsing.

Parameters

• <window>
  A window identifier whose contents are to be a web browser. If this is omitted, the next free window will be used.

• <url>
  The url to be initially displayed in <window>. If omitted, nothing is displayed in <window>.

Switches

• -at=<atable>
  An atable to be searched within callback procedures for this window. This means that any identifiers within <atable> referenced in a callback do not have to be prefixed by ~<atable>. This cannot be the local atable.

• -col=<color>
  The color of the window excluding the page display area. If omitted, a default color is used.

• -dec=<n>
  A specification of the window decoration to be added by the window manager. Possible values are:
      0 (or -no_dec) for no decoration at all,
      1 for full decoration (the default),
      >1 for custom decoration, see Window Decoration.

• -dim=<screen_xy>
  Define the dimensions of the window’s page display area in pixels. This should be a 2-element numeric array giving the width and height.

• -emb=<string> - Embed the window into a container provided by an external client. <string> is the name of an embed container created by the embed command. If the embed container does not exist or is invalid, this switch is ignored.

• -fix
  Create the window fixed size, i.e. non-resizable. The default is the value of window.resizable.

• -geo=<screen_box>
  The geometry of the window in screen co-ordinates, either just its position (a 2- element array) or its full rectangle geometry (a 4-element array). The default is the value of window.outrect.

• -gh
  The window should be initially ghosted, i.e. insensitive to user-interaction. The default is the current value of window.ghosted.

• -ic
  Create the window in iconic form. The default is the value of window.open.

• -inv
  Create the window invisible. The default is the value of window.visibility.

• -mas
  Define the window as a master window. When a master window is iconized, this also iconizes all other windows.

• -mb
  Give the window a menubar for user buttons. If omitted, the window will be created without a menubar.

• -mf=<font>
  The font to be used for menubar text. This must be a fixed font. If omitted a default fixed font is used. This option has no effect on Windows systems, where menubar font and color are controlled by the window manager.

• -num
  Include the window slot number in the window’s title. Use -no_num to suppress it. The default behavior is governed by the value of the system numeric window_numbers.

• -ocol=<color>
  The other color for use in the window excluding the page display area, e.g. for button text. If omitted, a default color is used.

• -pos=<screen_xy>
  The position of the window in screen co-ordinates. This is a 2-element array. The default is the value of window.outrect[1:2].

• -q
  Run the browser in quiet mode. By default, dialog boxes and messages are displayed, and critical errors and security alerts are not suppressed. In quiet mode, dialog boxes are not displayed.

• -sc
  Add scrollbars to the window. If omitted, the window is created without scrollbars.

• -sh=<string>
  A shell name for communication with X application resources. If omitted, the value "web" is used.

• -st
  Add a status bar at the bottom of the window. The default behavior is to omit the status bar.

• -tb
  Display the window icon in the Windows taskbar. The default behavior is not to display it in the taskbar but only to display it on the desktop when minimized. This switch has no meaning on Unix systems.

• -tit=<string>
  Provide a title for the window. The default is the value of window.title.

Notes

Web browser windows are currently available on Windows systems only.

Within any web page displayed in a web window, a fire command may be invoked in place of a reload-page by use of the Fire-specific "fire:" protocol prefix, e.g.

<p><a href=fire:wgraphic>New Graphic Window</a></p>

Note that if the fire command contains any of the following characters: space, quotes, &, < or >, the command string should be html-encoded and should not be quoted, e.g.

<p><a href=fire:wgraphic&nbsp;-no_num>New Graphic Window</a></p>

The html_encode function is available for encoding such sequences.

fire: directives do not invoke any of the pre or post callbacks, see window.pre_navigate.

Examples

Display a web page in a new window.

wweb http://www.xmarc.com

Display an HTML file in an existing window.

my_win = wweb c:/myfile.htm

See Also