usr/src/man/man3xcurses/add_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 ADD_WCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 add_wch, mvadd_wch, mvwadd_wch, wadd_wch \- add a complex character (with
   9 rendition) to a window
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBadd_wch\fR(\fBconst cchar_t *\fR\fIwch\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvadd_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBadd_wch()\fR function writes a complex character to the \fBstdscr\fR
  42 window at the current cursor position.  The \fBmvadd_wch()\fR and
  43 \fBmvwadd_wch()\fR functions write the character  to the position indicated by
  44 the \fIx\fR (column) and \fIy\fR (row) parameters. The \fBmvadd_wch()\fR
  45 function writes the character to the \fBstdscr\fR window, while
  46 \fBmvwadd_wch()\fR writes the character to the window specified  by \fIwin\fR.
  47 The \fBwadd_wch()\fR function is identical to \fBadd_wch()\fR, but writes the
  48 character to the window specified by \fIwin\fR.  These functions advance the
  49 cursor after writing the character.
  50 .sp
  51 .LP
  52 If \fIwch\fR is a spacing complex character, X/Open Curses replaces any
  53 previous  character at the specified location with \fIwch\fR (and its
  54 rendition). If \fIwch\fR is a non-spacing complex character, X/Open Curses
  55 preserves all existing characters at the specified location and adds the
  56 non-spacing  characters of \fIwch\fR to the spacing complex character. It
  57 ignores the  rendition associated with \fIwch\fR.
  58 .sp
  59 .LP
  60 Characters that do not fit on the end of the current line are wrapped to the
  61 beginning of the next line unless the current line is the last line of the
  62 window and scrolling is disabled. In that situation, X/Open Curses discards
  63 characters which extend beyond the end  of the line.
  64 .sp
  65 .LP
  66 When \fIwch\fR is a backspace, carriage return, newline, or tab, X/Open Curses
  67 moves the cursor appropriately as described in the \fBcurses\fR(3XCURSES) man
  68 page. Each tab character moves the cursor to the next tab stop. By default, tab
  69 stops occur every eight columns. When \fIwch\fR is a control character other
  70 than a backspace, carriage return, newline, or tab, it is written using
  71 \fB^\fR\fIx\fR notation, where \fIx\fR is a printable character. When X/Open
  72 Curses writes \fIwch\fR to the last character position on a line, it
  73 automatically generates a newline. When \fI wch\fR is written to the last
  74 character position of a scrolling region and \fBscrollok()\fR is enabled,
  75 X/Open Curses scrolls the scrolling region up one line (see
  76 \fBclearok\fR(3XCURSES)).
  77 .SH PARAMETERS
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIwch\fR\fR
  82 .ad
  83 .RS 7n
  84 Is the character/attribute pair (rendition) to be written to the window.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIwin\fR\fR
  91 .ad
  92 .RS 7n
  93 Is a pointer to the window in which the character is to be written.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIy\fR\fR
 100 .ad
 101 .RS 7n
 102 Is the y (row) coordinate of the character's position in the window.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fIx\fR\fR
 109 .ad
 110 .RS 7n
 111 Is the x (column) coordinate of the character's position in the window.
 112 .RE
 113
 114 .SH RETURN VALUES
 115 .sp
 116 .LP
 117 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 118 .SH ERRORS
 119 .sp
 120 .LP
 121 None.
 122 .SH ATTRIBUTES
 123 .sp
 124 .LP
 125 See \fBattributes\fR(5) for descriptions of the following attributes:
 126 .sp
 127
 128 .sp
 129 .TS
 130 box;
 131 c | c
 132 l | l .
 133 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 134 _
 135 Interface Stability     Standard
 136 _
 137 MT-Level        Unsafe
 138 .TE
 139
 140 .SH SEE ALSO
 141 .sp
 142 .LP
 143 \fBattr_off\fR(3XCURSES), \fBbkgrndset\fR(3XCURSES), \fBcurses\fR(3XCURSES),
 144 \fBdoupdate\fR(3XCURSES), \fBin_wch\fR(3XCURSES), \fBins_wch\fR(3XCURSES),
 145 \fBlibcurses\fR(3XCURSES), \fBnl\fR(3XCURSES), \fBprintw\fR(3XCURSES),
 146 \fBscrollok\fR(3XCURSES), \fBscrl\fR(3XCURSES), \fBsetscrreg\fR(3XCURSES),
 147 \fBterminfo\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)