usr/src/man/man3xcurses/delch.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DELCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 delch, mvdelch, mvwdelch, wdelch \- remove a character
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBdelch\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBmvdelch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBmvwdelch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBwdelch\fR(\fBWINDOW *\fR\fIwin\fR);
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBdelch()\fR and \fBwdelch()\fR functions delete the character at  the
  41 current cursor position from \fBstdscr\fR and \fIwin\fR, respectively.  All
  42 remaining characters after cursor through to the end of the line are shifted
  43 one character towards the start of the line. The last character on the line
  44 becomes a space; characters on other lines are  not affected.
  45 .sp
  46 .LP
  47 The \fBmvdelch()\fR and \fBmvwdelch()\fR functions delete the character at  the
  48 position specified by the \fIx\fR and \fIy\fR parameters; the former  deletes
  49 the character from \fBstdscr\fR; the latter from \fIwin\fR.
  50 .SH PARAMETERS
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIy\fR\fR
  55 .ad
  56 .RS 7n
  57 Is the y (row) coordinate of the position of the character  to be removed.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fIx\fR\fR
  64 .ad
  65 .RS 7n
  66 Is the x (column) coordinate of the position of the character  to be removed.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fIwin\fR\fR
  73 .ad
  74 .RS 7n
  75 Is a pointer to the window containing the character to be removed.
  76 .RE
  77
  78 .SH RETURN VALUES
  79 .sp
  80 .LP
  81 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 None.
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        Unsafe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBbkgdset\fR(3XCURSES), \fBinsch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 108 \fBattributes\fR(5), \fBstandards\fR(5)