usr/src/man/man3curses/curs_inswch.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_INSWCH 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_inswch, inswch, winswch, mvinswch, mvwinswch \- insert a wchar_t character
  10 before the character under the cursor in a curses window
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR .. ]
  15 #include <curses.h>
  16
  17 \fBint\fR \fBinswch\fR(\fBchtype\fR \fIwch\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBwinswch\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIwch\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBmvinswch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIwch\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fBmvwinswch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIwch\fR);
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 These routines insert the character  \fIwch\fR, holding a  \fBwchar_t\fR
  39 character, before the character under the cursor. All characters to the right
  40 of the cursor are moved one space to the right, with the possibility of the
  41 rightmost character on the line being lost. The cursor position does not change
  42 (after moving to \fIy\fR, \fIx\fR, if specified). (This does not imply use of
  43 the hardware insert character feature.)
  44 .SH RETURN VALUE
  45 .sp
  46 .LP
  47 All routines return the integer \fBERR\fR upon failure and an integer value
  48 other than \fBERR\fR upon successful completion.
  49 .SH ATTRIBUTES
  50 .sp
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 MT-Level        Unsafe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  69 .SH NOTES
  70 .sp
  71 .LP
  72 The header file <\fBcurses.h\fR> automatically includes the header files
  73 <\fBstdio.h\fR>, <\fBunctrl.h\fR> and <\fBwidec.h\fR>.
  74 .sp
  75 .LP
  76 Note that  \fBinswch()\fR, \fBmvinswch()\fR, and  \fBmvwinswch()\fR may be
  77 macros.
  78 .sp
  79 .LP
  80 None of these routines can use the color attribute in \fBchtype\fR.