lib/libcurses/curses_insertch.3

   1 .\"     $NetBSD: curses_insertch.3,v 1.4 2006/02/05 17:07:13 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 February 5, 2006
  34 .Dt CURSES_INSERTCH 3
  35 .Os
  36 .Sh NAME
  37 .Nm curses_insert ,
  38 .Nm insch ,
  39 .Nm winsch ,
  40 .Nm mvinsch ,
  41 .Nm mvwinsch
  42 .Nd curses insert characters routines
  43 .Sh LIBRARY
  44 .Lb libcurses
  45 .Sh SYNOPSIS
  46 .In curses.h
  47 .Ft int
  48 .Fn insch "chtype ch"
  49 .Ft int
  50 .Fn winsch "WINDOW *win" "chtype ch"
  51 .Ft int
  52 .Fn mvinsch "int y" "int x" "chtype ch"
  53 .Ft int
  54 .Fn mvwinsch "WINDOW *win" "int y" "int x" "chtype ch"
  55 .Sh DESCRIPTION
  56 These functions insert characters on
  57 .Dv stdscr
  58 or on the specified window.
  59 .Pp
  60 The
  61 .Fn insch
  62 function inserts the character given in
  63 .Fa ch
  64 at the current cursor position on
  65 .Dv stdscr .
  66 The cursor is not advanced and wrapping is not performed.
  67 .Pp
  68 The
  69 .Fn winsch
  70 function is the same as the
  71 .Fn insch
  72 function, excepting that the character is inserted on the window specified by
  73 .Fa win .
  74 .Pp
  75 The
  76 .Fn mvinsch
  77 and
  78 .Fn mvwinsch
  79 functions are the same as the
  80 .Fn insch
  81 and
  82 .Fn insch
  83 functions, respectively, excepting that
  84 .Fn wmove
  85 is called to move the cursor to the position specified by
  86 .Fa y ,
  87 .Fa x
  88 before the character is inserted on the window.
  89 .Sh RETURN VALUES
  90 Functions returning pointers will return
  91 .Dv NULL
  92 if an error is detected.
  93 The functions that return an int will return one of the following
  94 values:
  95 .Pp
  96 .Bl -tag -width ERR -compact
  97 .It Er OK
  98 The function completed successfully.
  99 .It Er ERR
 100 An error occurred in the function.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr curses_addch 3 ,
 104 .Xr curses_cursor 3 ,
 105 .Xr curses_delch 3
 106 .Sh STANDARDS
 107 The
 108 .Nx
 109 Curses library complies with the X/Open Curses specification, part of
 110 the Single Unix Specification.
 111 .Sh HISTORY
 112 The Curses package appeared in
 113 .Bx 4.0 .