diff options
Diffstat (limited to 'upstream/debian-unstable/man3/delch.3ncurses')
-rw-r--r-- | upstream/debian-unstable/man3/delch.3ncurses | 77 |
1 files changed, 54 insertions, 23 deletions
diff --git a/upstream/debian-unstable/man3/delch.3ncurses b/upstream/debian-unstable/man3/delch.3ncurses index 36d9663d..33ac1a17 100644 --- a/upstream/debian-unstable/man3/delch.3ncurses +++ b/upstream/debian-unstable/man3/delch.3ncurses @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_delch.3x,v 1.30 2023/12/16 21:09:11 tom Exp $ -.TH delch 3NCURSES 2023-12-16 "ncurses 6.4" "Library calls" +.\" $Id: curs_delch.3x,v 1.34 2024/04/20 19:24:14 tom Exp $ +.TH delch 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -44,7 +44,7 @@ \fB\%wdelch\fP, \fB\%mvdelch\fP, \fB\%mvwdelch\fP \- -delete the character at the cursor in a \fIcurses\fR window +delete a character from a \fIcurses\fR window .SH SYNOPSIS .nf \fB#include <curses.h> @@ -55,28 +55,59 @@ delete the character at the cursor in a \fIcurses\fR window \fBint mvwdelch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); .fi .SH DESCRIPTION -These routines delete the character under the cursor; all characters to the -right of the cursor on the same line are moved to the left one position and the -last character on the line is filled with a blank. -The cursor position does -not change (after moving to \fIy\fP, \fIx\fP, if specified). -(This does not -imply use of the hardware delete character feature.) +.B \%wdelch +deletes the character at the cursor position in +.IR win . +\fB\%ncurses\fP(3NCURSES) describes the variants of this function. +.PP +.B \%wdelch +moves all characters to the right of the cursor on the same line to the +left one position and replaces the contents of the rightmost position on +the line with the window's blank character; +see \fB\%bkgd\fP(3NCURSES) +(wide-character API users may consult \fB\%bkgrnd\fP(3NCURSES) instead). +The cursor position does not change +(after moving to +.RI ( y , +.IR x ), +if specified). .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an \fBOK\fP -(SVr4 specifies only -\*(``an integer value other than \fBERR\fP\*('') -upon successful completion. +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that \fBdelch\fP, \fBmvdelch\fP, and \fBmvwdelch\fP may be macros. +.BR \%delch , +.BR \%mvdelch , +and +.B \%mvwdelch +may be implemented as macros. +.PP +A terminal's +.B \%delete_character +.RB ( dch1 ) +capability +is not necessarily employed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The -standard specifies that they return \fBERR\fP on failure, but specifies no -error conditions. +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. .SH SEE ALSO \fB\%ncurses\fP(3NCURSES) |