Name

leaveok − enable non-tracking cursor

Syntax

#include <cursesX.h>

int leaveok(win, bf)
WINDOW ∗win;
bool bf;

Description

This option allows the cursor to be left wherever the update happens to leave it.  Normally, the cursor is left at the current location (y, x) of the window being refreshed.  This routine is useful for applications where the cursor is not used, since it reduces the need for cursor motions.  If possible, the cursor is made invisible when this option is enabled. 

This option is initially disabled, and is not enabled until the value of bf is changed from FALSE to TRUE.

Return Values

The leaveok function returns OK on success and ERR on error.