usr/src/man/man3xcurses/ins_wch.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH INS_WCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 ins_wch, wins_wch, mvins_wch, mvwins_wch \- insert a complex character
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBins_wch\fR(\fBconst cchar_t *\fR\fIwch\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBmvins_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBmvwins_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBwins_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR);
  35 .fi
  36
  37 .SH PARAMETERS
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIwch\fR\fR
  42 .ad
  43 .RS 7n
  44 Is the complex character to be inserted.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIy\fR\fR
  51 .ad
  52 .RS 7n
  53 Is the y (row) coordinate of the position of the character.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIx\fR\fR
  60 .ad
  61 .RS 7n
  62 Is the x (column) coordinate of the position of the character.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIwin\fR\fR
  69 .ad
  70 .RS 7n
  71 Is a pointer to the window in which the character is to be inserted.
  72 .RE
  73
  74 .SH DESCRIPTION
  75 .sp
  76 .LP
  77 The \fBins_wch()\fR function inserts the complex  character \fIwch\fR at  the
  78 current cursor position of the \fBstdscr\fR window. The \fBwins_wch()\fR
  79 function performs the identical action but in window \fIwin\fR.  The
  80 \fBmvins_wch()\fR and \fBmvwins_wch()\fR functions insert the character at the
  81 position indicated by the \fIx\fR (column) and \fIy\fR (row) parameters  (the
  82 former in the \fBstdscr\fR window; the latter in window \fIwin\fR).  The cursor
  83 position does not change.
  84 .sp
  85 .LP
  86 All characters to the right of the inserted character are moved right one
  87 character.  The last character on the line is deleted.
  88 .sp
  89 .LP
  90 Insertions and deletions occur at the character level. The cursor is adjusted
  91 to the first column of the character prior to the operation.
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  96 .SH ERRORS
  97 .sp
  98 .LP
  99 None.
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Standard
 114 _
 115 MT-Level        Unsafe
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBadd_wch\fR(3XCURSES), \fBins_nwstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 122 \fBattributes\fR(5), \fBstandards\fR(5)