scrollok Subroutine

AIX Version 4.3 Base Operating System and Extensions Technical Reference, Volume 2

scrollok Subroutine

Purpose

Enables or disables scrolling.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

scrollok(Window, Flag)
WINDOW *Window;
bool Flag;

Description

The scrollok subroutine enables or disables scrolling. Scrolling occurs when a program or user:

Moves the cursor off the window's bottom edge.
Enters a new-line character on the last line.
Types the last character of the last line.

If enabled, curses calls a refresh as part of the scrolling action on both the window and the physical display. To get the physical scrolling effect on the terminal, it is also necessary to call the idlok subroutine.

If scrolling is disabled, the cursor is left on the bottom line at the location where the character was entered.

Parameters

Flag	Enables scrolling when set to TRUE. Otherwise, set the Flag parameter to FALSE to disable scrolling.
Window	Identifies the window to enable or disable scrolling in.

Examples

To turn scrolling on in the user-defined window my_window, enter:
```
WINDOW *my_window;
scrollok(my_window, TRUE);
```
To turn scrolling off in the user-defined window my_window, enter:
```
WINDOW *my_window;
scrollok(my_window, FALSE);
```

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The idlok subroutine.

Curses Overview for Programming, List of Curses Subroutines, Manipulating Characters with Curses in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.