te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
curs_inswstr, inswstr, insnwstr, winswstr, winsnwstr, mvinswstr, mvinsnwstr, mvwinswstr, mvwinsnwstr - insert wchar_t string before character under the cursor in a curses window

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);

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.

All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

MT-Level Unsafe

clrtoeol(3CURSES), curses(3CURSES), winwch(3CURSES), attributes(5)

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.