Element: window.flash( )

Type

numeric func

Description

A function to flash the window, thus attracting the attention of the operator's attention. This function takes no acion on Unix systems.

The function takes a numeric parameter whose value defines the flashing characteristics, as follows:

Value

Details

n

Flash the window n times. The window caption is flashed, or the window icon if the window is currently iconic.

0

Stop the window flashing.

-1

Flash the window continuously until a call to window.flash(0) is made to stop it.

-2

Flash the window continuously until the window is a foreground window. Typically a window is already a foreground window, in which case the window will flash just once.

The parameter may be omitted, in which case a value 1 is assumed.

A value of 0 is returned when successful, and a value of 1 is returned on error.

The code of the function cannot be redefined.

Parameters

window.flash(<window>,<num>)

The function may be called in one of two ways:

# Assume mywin is the window identifier
window.flash(mywin,2)

or

mywin.flash(2)

Value	Details
n	Flash the window n times. The window caption is flashed, or the window icon if the window is currently iconic.
0	Stop the window flashing.
-1	Flash the window continuously until a call to window.flash(0) is made to stop it.
-2	Flash the window continuously until the window is a foreground window. Typically a window is already a foreground window, in which case the window will flash just once.