CURS_INSWSTR(3CURSES) Curses Library Functions CURS_INSWSTR(3CURSES)
NAME
curs_inswstr, inswstr, insnwstr, winswstr, winsnwstr, mvinswstr,
mvinsnwstr, mvwinswstr, mvwinsnwstr - insert wchar_t string before
character under the cursor in a curses window
SYNOPSIS
cc [
flag ... ]
file ...
-lcurses [
library .. ]
#include <curses.h>
int inswstr(
wchar_t *wstr);
int insnwstr(
wchar_t *wstr,
int n);
int winswstr(
WINDOW *win,
wchar_t *wstr);
int winsnwstr(
WINDOW *win,
wchar_t *wstr,
int n);
int mvinswstr(
int y,
int x,
wchar_t *wstr);
int mvinsnwstr(
int y,
int x,
wchar_t *wstr,
int n);
int mvwinswstr(
WINDOW *win,
int y,
int x,
wchar_t *wstr);
int mvwinsnwstr(
WINDOW *win,
int y,
int x,
wchar_t *wstr,
int n);
DESCRIPTION
These routines insert a
wchar_t character string (as many
wchar_t characters as will fit on the line) before the character under the
cursor. All characters to the right of the cursor are moved to the
right, with the possibility of the rightmost characters on the line
being lost. The cursor position does not change (after moving to
y,
x, if specified). (This does not imply use of the hardware insert
character feature.) The four routines with
n as the last argument
insert at most
n wchar_t characters. If
n<=0, then the entire string
is inserted.
If a character in
wstr is a tab, newline, carriage return, or
backspace, the cursor is moved appropriately within the window. A
newline also does a
clrtoeol(3CURSES) before moving. Tabs are
considered to be at every eighth column. If a character in
wstr is
another control character, it is drawn in the
^X notation. Calling
winwch(3CURSES) after adding a control character (and moving to it,
if necessary) does not return the control character, but instead
returns the representation of the control character.
RETURN VALUE
All routines return the integer
ERR upon failure and an integer value
other than
ERR upon successful completion.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+---------------+-----------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------+
|MT-Level | Unsafe |
+---------------+-----------------+
SEE ALSO
clrtoeol(3CURSES),
curses(3CURSES),
winwch(3CURSES),
attributes(7)NOTES
The header file <
curses.h> automatically includes the header files
<
stdio.h>, <
unctrl.h> and <
widec.h>.
Note that all but
winsnwstr() may be macros.
December 31, 1996 CURS_INSWSTR(3CURSES)