Command: wscroll

Syntax

wscroll <window>

Description

Scroll a window.

Parameters

• <window>
  A window identifier. The window must be one of the following window types and must have scrollbars:

• alpha

• display

• graphic

• panel

• table

Switches

• -col=<num>
  Alpha, display and panel windows only. Scroll the window so that the num-th character column (for an alpha window), or the num-th image pixel column (for a display or panel window) is visible along the left edge.

• -d=<num>
  Scroll down <num> increments (see -p).

• -l=<num>
  Alpha, display, graphic and panel windows only. Scroll left <num> positions. For an alpha window a position is one character, for a display window a position is one image pixel, for a graphic or panel window a position is one screen pixel.

• -m=<point>
  Graphic windows only. Scroll the window so that the supplied 3-D point is in the middle of the window.

• -p
  When combined with the -u or -d switches, scrolling is done vertically in increments of one page, i.e. a window-full. If this is omitted, or ignored as is the case with panel windows, scrolling is done in increments of one row. The meaning of a "row" is different depending on the window type:

• alpha window: a row of characters

• display window: a row of image pixels

• graphic window: a row of screen pixels

• panel window: a row of screen pixels

• table window: a row/column of sub-panels

• -pos=<nums>
  Alpha, display, panel and table windows only, nums is a 2-element numeric array. Scroll the window so that column nums[1] and row nums[2] are visible. This is an alternative to using the -row and -col switches.

• -r=<num>
  Scroll right <num> positions (see -l).

• -row=<num> Alpha, display, panel and table windows only. Scroll the window so that the num-th row is visible along the top edge.

• -u=<num>
  Scroll up <num> increments (see -p).

Notes

If the window is not currently in use, or is not an alpha, display. panel, graphic or table window, no action is taken.

When the window is an alpha or table window, if no scroll movement switches are included, -d=1 is executed.

Table windows can only be scrolled programmatically in their minor direction. For this reason, -l and -u are treated identically, similarly with -r and -d.

Examples

Scroll the window (alpha) down one logical row.

wscroll awin

Scroll the window (alpha) down one page.

wscroll awin, -p

Scroll the window (any) up 10 logical rows.

wscroll mywin, -u=10

Scroll the window (graphic) to a mid-point.

wscroll gwin, -m=(500,500)

See Also