NAME
newwin, delwin, mvwin, subwin, derwin, mvderwin, dupwin, wsyncup, syncok, wcursyncup, wsyncdown - create curses windows
SYNOPSIS
#include <curses.h> WINDOW *newwin( int nlines, int ncols, int begin_y, int begin_x); int delwin(WINDOW *win); int mvwin(WINDOW *win, int y, int x); WINDOW *subwin(WINDOW *orig, int nlines, int ncols, int begin_y, int begin_x); WINDOW *derwin(WINDOW *orig, int nlines, int ncols, int begin_y, int begin_x); int mvderwin(WINDOW *win, int par_y, int par_x); WINDOW *dupwin(WINDOW *win); void wsyncup(WINDOW *win); int syncok(WINDOW *win, bool bf); void wcursyncup(WINDOW *win); void wsyncdown(WINDOW *win);
DESCRIPTION
newwin Calling newwin creates and returns a pointer to a new window with the given number of lines and columns. The upper left-hand corner of the window is at line begin_y, column begin_x If either nlines or ncols is zero, they default to LINES - begin_y and COLS - begin_x. A new full-screen window is created by calling newwin(0,0,0,0). delwin Calling delwin deletes the named window, freeing all memory associated with it (it does not actually erase the window's screen image). Subwindows must be deleted before the main window can be deleted. mvwin Calling mvwin moves the window so that the upper left-hand corner is at position (x, y). If the move would cause the window to be off the screen, it is an error and the window is not moved. Moving subwindows is allowed, but should be avoided. subwin Calling subwin creates and returns a pointer to a new window with the given number of lines, nlines, and columns, ncols. The window is at position (begin_y, begin_x) on the screen. The subwindow shares memory with the window orig, so that changes made to one window will affect both windows. When using this routine, it is necessary to call touchwin or touchline on orig before calling wrefresh on the subwindow. derwin Calling derwin is the same as calling subwin, except that begin_y and begin_x are relative to the origin of the window orig rather than the screen. There is no difference between the subwindows and the derived windows. Calling mvderwin moves a derived window (or subwindow) inside its parent window. The screen-relative parameters of the window are not changed. This routine is used to display different parts of the parent window at the same physical position on the screen. dupwin Calling dupwin creates an exact duplicate of the window win. wsyncup Calling wsyncup touches all locations in ancestors of win that are changed in win. If syncok is called with second argument TRUE then wsyncup is called automatically whenever there is a change in the window. wsyncdown The wsyncdown routine touches each location in win that has been touched in any of its ancestor windows. This routine is called by wrefresh, so it should almost never be necessary to call it manually. wcursyncup The routine wcursyncup updates the current cursor position of all the ancestors of the window to reflect the current cursor position of the window.
RETURN VALUE
Routines that return an integer return the integer ERR upon failure and OK (SVr4 only specifies "an integer value other than ERR") upon successful completion. Routines that return pointers return NULL on error. X/Open defines no error conditions. In this implementation delwin returns an error if the window pointer is null, or if the window is the parent of another window. derwin returns an error if the parent window pointer is null, or if any of its ordinates or dimensions is negative, or if the resulting window does not fit inside the parent window. dupwin returns an error if the window pointer is null. This implementation also maintains a list of windows, and checks that the pointer passed to delwin is one that it created, returning an error if it was not.. mvderwin returns an error if the window pointer is null, or if some part of the window would be placed off-screen. mvwin returns an error if the window pointer is null, or if the window is really a pad, or if some part of the window would be placed off-screen. newwin will fail if either of its beginning ordinates is negative, or if either the number of lines or columns is negative. syncok returns an error if the window pointer is null. subwin returns an error if the parent window pointer is null, or if any of its ordinates or dimensions is negative, or if the resulting window does not fit inside the parent window. The functions which return a window pointer may also fail if there is insufficient memory for its data structures. Any of these functions will fail if the screen has not been initialized, i.e., with initscr or newterm.
NOTES
If many small changes are made to the window, the wsyncup option could degrade performance. Note that syncok may be a macro.
BUGS
The subwindow functions (subwin, derwin, mvderwin, wsyncup, wsyncdown, wcursyncup, syncok) are flaky, incompletely implemented, and not well tested. The System V curses documentation is very unclear about what wsyncup and wsyncdown actually do. It seems to imply that they are only supposed to touch exactly those lines that are affected by ancestor changes. The language here, and the behavior of the curses implementation, is patterned on the XPG4 curses standard. The weaker XPG4 spec may result in slower updates.
PORTABILITY
The XSI Curses standard, Issue 4 describes these functions.
SEE ALSO
ncurses(3NCURSES), refresh(3NCURSES), touch(3NCURSES), curses_variables(3NCURSES) window(3NCURSES)
More Linux Commands
manpages/win.3menu.html
win(3menu) - make and break menu window and subwindow associ
Every menu has an associated pair of curses windows. The menu window displays any title and border associated with the window; the menu subwindow displays the i
manpages/md4.1ssl.html
md4(1ssl) message digests (Commands - Linux manual page)....
The digest functions output the message digest of a supplied file or files in hexadecimal. The digest functions also generate and verify digital signatures usin
manpages/rawmemchr.3.html
rawmemchr(3) - scan memory for a character - Linux man page
The memchr() function scans the initial n bytes of the memory area pointed to by s for the first instance of c. Both c and the bytes of the memory area pointed
manpages/attr_on.3ncurses.html
attr_on(3ncurses) - curses character and window attribute co
These routines manipulate the current attributes of the named window. The current attributes of a window apply to all characters that are written into the windo
manpages/has_ic_sp.3ncurses.html
has_ic_sp(3ncurses) - curses screen-pointer extension.......
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th
manpages/SDL_GL_LoadLibrary.3.html
SDL_GL_LoadLibrary(3) - Specify an OpenGL library (ManPage)
If you wish, you may load the OpenGL library at runtime, this must be done before SDL_SetVideoMode is called. The path of the GL library is passed to SDL_GL_Loa
manpages/SDL_keysym.3.html
SDL_keysym(3) - Keysym structure (Library - Linux man page)
The SDL_keysym structure is used by reporting key presses and releases since it is a part of the SDL_KeyboardEvent. The scancode field should generally be left
manpages/glMapGrid1f.3gl.html
glMapGrid1f(3gl) - define a one- or two-dimensional mesh....
glMapGrid and glEvalMesh are used together to efficiently generate and evaluate a series of evenly-spaced map domain values. glEvalMesh steps through the intege
manpages/sd_notifyf.3.html
sd_notifyf(3) - Notify init system about start-up completion
sd_notify() shall be called by a daemon to notify the init system about status changes. It can be used to send arbitrary information, encoded in an environment-
manpages/gnutls_x509_crt_set_proxy.3.html
gnutls_x509_crt_set_proxy(3) - API function - Linux man page
This function will set the proxyCertInfo extension. RETURNS On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value. REPORTING BUGS Repor
manpages/dracut-shutdown.service.8.html
dracut-shutdown.service(8) unpack the initramfs to run initr
This service unpacks the initramfs image to /run/initramfs. systemd pivots into /run/initramfs at shutdown, so the root filesytem can be safely unmounted. The f
manpages/ckrealloc.3.html
ckrealloc(3) - allocate or free heap memory - Linux man page
These procedures provide a platform and compiler independent interface for memory allocation. Programs that need to transfer ownership of memory blocks between
