usr/src/man/man3curses/curs_delch.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_DELCH 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_delch, delch, wdelch, mvdelch, mvwdelch \- delete character under cursor
  10 in a curses window
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16
  17 \fBint\fR \fBdelch\fR(\fBvoid\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBwdelch\fR(\fBWINDOW *\fR\fIwin\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBmvdelch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fBmvwdelch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 With these routines the character under the cursor in the window is deleted;
  39 all characters to the right of the cursor on the same line are moved to the
  40 left one position and the last character on the line is filled with a blank.
  41 The cursor position does not change (after moving to \fIy\fR, \fIx\fR, if
  42 specified). This does not imply use of the hardware delete character feature.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 All routines return the integer \fBERR\fR upon failure and an integer value
  47 other than \fBERR\fR upon successful completion.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 MT-Level        Unsafe
  62 .TE
  63
  64 .SH SEE ALSO
  65 .sp
  66 .LP
  67 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  68 .SH NOTES
  69 .sp
  70 .LP
  71 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
  72 and <\fBunctrl.h\fR>.
  73 .sp
  74 .LP
  75 Note that \fBdelch()\fR, \fBmvdelch()\fR, and \fBmvwdelch()\fR may be macros.