xref: /netbsd-src/lib/libcurses/curses_addch.3 (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1.\"	$NetBSD: curses_addch.3,v 1.5 2003/05/21 21:22:15 jdc Exp $
2.\"
3.\" Copyright (c) 2002
4.\"	Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
5.\"
6.\" This code is donated to the NetBSD Foundation by the Author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"
33.Dd May 21, 2003
34.Dt CURSES_ADDCH 3
35.Os
36.Sh NAME
37.Nm curses_addch ,
38.Nm addch ,
39.Nm waddch ,
40.Nm mvaddch ,
41.Nm mvwaddch
42.Nd curses add characters to windows routines
43.Sh LIBRARY
44.Lb libcurses
45.Sh SYNOPSIS
46.In curses.h
47.Ft int
48.Fn addch "chtype ch"
49.Ft int
50.Fn waddch "WINDOW *win" "chtype ch"
51.Ft int
52.Fn mvaddch "int y" "int x" "chtype ch"
53.Ft int
54.Fn mvwaddch "WINDOW *win" "int y" "int x" "chtype ch"
55.Sh DESCRIPTION
56These functions add characters to
57.Dv stdscr
58or to the specified window.
59.Pp
60The
61.Fn addch
62function adds the character given in
63.Fa ch
64to
65.Dv stdscr
66at the current cursor position and advances the current cursor position by one.
67Any character attributes set in
68.Fa ch
69will be merged with the background attributes currently set on
70.Dv stdscr .
71.Pp
72The
73.Fn waddch
74function is the same as the
75.Fn addch
76function, excepting that the character is added to the window specified by
77.Fa win .
78.Pp
79The
80.Fn mvaddch
81and
82.Fn mvwaddch
83functions are the same as the
84.Fn addch
85and
86.Fn waddch
87functions, respectively, excepting that
88.Fn wmove
89is called to move the cursor to the position specified by
90.Fa y ,
91.Fa x
92before the character is added to the window.
93.Sh RETURN VALUES
94Functions returning pointers will return
95.Dv NULL
96if an error is detected.
97The functions that return an int will return one of the following
98values:
99.Pp
100.Bl -tag -width ERR -compact
101.It Er OK
102The function completed successfully.
103.It Er ERR
104An error occurred in the function.
105.El
106.Sh SEE ALSO
107.Xr curses_addchstr 3 ,
108.Xr curses_addstr 3 ,
109.Xr curses_attributes 3 ,
110.Xr curses_cursor 3 ,
111.Xr curses_delch 3 ,
112.Xr curses_inch 3 ,
113.Xr curses_insertch 3
114.Sh STANDARDS
115The
116.Nx
117Curses library complies with the X/Open Curses specification, part of the
118Single Unix Specification.
119.Sh HISTORY
120The Curses package appeared in
121.Bx 4.0 .
122