GET_INFO (SCREEN)

This form uses two parameters except where noted below. The first parameter is the keyword SCREEN. The second parameter is any of the following words.

Parameter 2 Return

"active_area" Returns an array containing the dimensions of the window's active area, which is defined as a rectangle where mouse drag actions are not reported. Active areas allow for small mouse movements between mouse clicks. The size of the active area is normally one character cell, and by default is the cell under the cursor. A five element array is returned. The array elements are defined below. This is only valid in a windowed environment.

array {1} = window containing the active area

array {2} = leftmost column

array {3} = uppermost row

array {4} = width in columns

array {5} = height in rows

"ansi_crt" Returns integer 1 if the terminal is an ANSI device or 0 if it is not.

"auto_repeat" Returns integer 1 if the terminal has auto repeat on or 0 if auto repeat is off.

"avo" Always 0.

“background” Returns video keyword for current background color.

"client_message" Only used in a windowed environment. Returns integer 0 if there is no client message, the keyword KILL_SELECTION when copying from a layered application, or the keyword STUFF_SELECTION when copying from any application into a layered application.

"client_message_routine” Only used in a windowed environment. Returns program or learn sequence associated with an application's client message action routine or 0 if none exists.

"cross_window_bounds” Returns integer 1 if CURSOR_VERTICAL command can change the current window settings.

"current_column" Returns the current screen column.

"current_row" Returns the current screen row.

"dec_crt" Returns 1. Obsolete: Use GET_INFO (SCREEN, "term").

"dec_crt2" Returns 1. Obsolete: Use GET_INFO (SCREEN, "term").

"detached_action" Returns current detached action routine or 0 if none exists.

"detached_reason" Returns bit-encoded integer indicating status of detached cursor.

"edit_mode" Returns integer 1 if the terminal is in edit mode or 0 if it is not.

"eightbit" Returns integer 1 if the terminal is in eightbit mode or 0 if it is not.

"event" Only used in windowed environment, and with the keyword GLOBAL_SELECT as the third parameter. Returns the keyword PRIMARY or SECONDARY or a string naming the global selection if called during a GRAB or UNGRAB routine. Returns a two element array if called during a READ routine. The array's first element is the global selection nu/TPU is requested to respond to; the second element is the global selection property type. If this built-in is not called during one of these three events, 0 is returned.

“foreground” Return video keyword for current foreground color.

"global_select" Only used in windowed environment. Third parameter is PRIMARY, SECONDARY, or a selection name string. Returns 1 if selection is owned by nu/TPU, 0 if it is not.

"grab_routine" Only used in windowed environment. Third parameter is either GLOBAL_SELECT or INPUT_FOCUS. Returns the program or learn sequence associated with the application's global selection or input focus grab routine, or 0 if routine is absent.

"icon_name" Only used in windowed environment. Returns the string naming the layered application in the icon box.

"input_focus" Only used in windowed environment. Returns 1 if input focus is currently owned, or 0 if it is not.

"length" Returns current screen length in rows.

"line_editing" Returns 1 or 0, depending on the current line editing mode.

"mouse" Only used in windowed environment. Returns 1 if mouse action is turned on or 0 if it is off.

"new_length" Only used in windowed environment. Returns screen length after executing resize action routine.

"new_width" Only used in windowed environment. Returns screen width after executing resize action routine.

"old_length" Only used in windowed environment. Returns screen length before latest resizing.

"old_width" Only used in windowed environment. Returns screen width before latest resizing.

"original_length" Returns screen length when nu/TPU was started.

"original_width" Returns screen width when nu/TPU was started.

"prompt_length" Returns the number of lines in the prompt area.

"prompt_row" Returns the screen line number where prompt area begins.

"read_routine" Only used in windowed environment, and keyword GLOBAL_SELECT must be used in third parameter. Returns the program or learn sequence executed when information is requested on an owned global selection or 0 if no routine is specified.

"screen_limits" Only used in windowed environment. Returns an array specifying the maximum and minimum window sizes. The array elements are defined below:

array {1} = minimum screen width in columns

array {2} = minimum screen height in rows

array {3} = maximum screen width in columns

array {4} = maximum screen height in rows

"screen_update" Returns integer 1 if the screen updating is on.

"scroll" Returns integer 1 if the terminal has scroll regions or 0 if none exist.

"term" Returns the value of the environment variable TERM. Not available under VMS.

"time" Only used in windowed environment, and keyword GLOBAL_SELECT must be used in third parameter. Returns an integer for the number of milliseconds telling how long after global selection request nu/TPU will await a reply.

"ungrab_routine" Only used in windowed environment, and keyword GLOBAL_SELECT or INPUT_FOCUS must be used in third parameter. Returns the program or learn sequence executed upon loss of global selection ownership or input focus. Returns 0 if ungrab routine is absent.

"visible_length" Returns the number of lines visible on the screen.

"vt100" Returns integer 0. Obsolete: Use GET_INFO (SCREEN, "term").

"vt200" Returns integer 0. Obsolete: Use GET_INFO (SCREEN, "term").

"vt300" Returns integer 0. Obsolete: Use GET_INFO (SCREEN, "term").

"width" Returns the screen width.

"windows" Returns integer 1 if you are running a Motif or MS Windows version of nu/TPU or 0 if you are not.

Syntax:

value := GET_INFO ( SCREEN, request )

Example:

The following returns the area of the screen.

COPY_TEXT (STR (GET_INFO (SCREEN, "length") * GET_INFO (SCREEN, "width")));