man/curs_delch.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_delch.3x,v 1.35 2024/05/11 20:39:53 tom Exp $
  31 .TH curs_delch 3X 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .SH NAME
  43 \fB\%delch\fP,
  44 \fB\%wdelch\fP,
  45 \fB\%mvdelch\fP,
  46 \fB\%mvwdelch\fP \-
  47 delete a character from a \fIcurses\fR window
  48 .SH SYNOPSIS
  49 .nf
  50 \fB#include <curses.h>
  51 .PP
  52 \fBint delch(void);
  53 \fBint wdelch(WINDOW *\fIwin\fP);
  54 \fBint mvdelch(int \fIy\fP, int \fIx\fP);
  55 \fBint mvwdelch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
  56 .fi
  57 .SH DESCRIPTION
  58 .B \%wdelch
  59 deletes the character at the cursor position in
  60 .IR win .
  61 It moves all characters to the right of the cursor on the same line to
  62 the left one position and replaces the contents of the rightmost
  63 position on the line with the window's blank character;
  64 see \fB\%bkgd\fP(3X)
  65 (wide-character API users: \fB\%bkgrnd\fP(3X)).
  66 The cursor position does not change
  67 (after moving to
  68 .RI ( y ,
  69 .IR x ),
  70 if specified).
  71 \fB\%ncurses\fP(3X) describes the variants of this function.
  72 .SH RETURN VALUE
  73 These functions return
  74 .B OK
  75 on success and
  76 .B ERR
  77 on failure.
  78 .PP
  79 Functions taking a
  80 .I \%WINDOW
  81 pointer argument fail if the pointer is
  82 .BR NULL .
  83 .PP
  84 Functions prefixed with \*(``mv\*('' first perform cursor movement and
  85 fail if the position
  86 .RI ( y ,
  87 .IR x )
  88 is outside the window boundaries.
  89 .SH NOTES
  90 .BR \%delch ,
  91 .BR \%mvdelch ,
  92 and
  93 .B \%mvwdelch
  94 may be implemented as macros.
  95 .PP
  96 A terminal's
  97 .B \%delete_character
  98 .RB ( dch1 )
  99 capability
 100 is not necessarily employed.
 101 .SH PORTABILITY
 102 X/Open Curses,
 103 Issue 4 describes these functions.
 104 It specifies no error conditions for them.
 105 .PP
 106 SVr4
 107 .I curses
 108 describes a successful return value only as
 109 \*(``an integer value other than
 110 .BR ERR \*(''.
 111 .SH SEE ALSO
 112 \fB\%curses\fP(3X)