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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, 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 CHGAT 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 chgat, mvchgat, mvwchgat, wchgat \- change the rendition of characters in a
   9 window
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBchgat\fR(\fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR, \fBconst void *\fR\fIopts\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBmvchgat\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR,
  26      \fBconst void *\fR\fIopts\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBint\fR \fBmvwchgat\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR,
  32      \fBshort\fR \fIcolor\fR, \fBconst void *\fR\fIopts\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBwchgat\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR,
  38      \fBconst void *\fR\fIopts\fR);
  39 .fi
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 These  functions change the renditions of the next \fIn\fR characters in the
  45 current or specified window (or of the remaining characters on the current or
  46 specified line, if \fIn\fR is \(mi1),  beginning at the current or specified
  47 cursor position. The attributes and colors are specified by \fIattr\fR and
  48 \fIcolor\fR as for \fBsetcchar\fR(3XCURSES).
  49 .sp
  50 .LP
  51 These function neither update the cursor nor perform wrapping.
  52 .sp
  53 .LP
  54 A value of \fIn\fR that is greater than the remaining  characters on a line is
  55 not an error.
  56 .sp
  57 .LP
  58 The \fIopts\fR argument is reserved for definition in a future release.
  59 Currently, the application must provide a null pointer for \fIopts\fR.
  60 .SH PARAMETERS
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIn\fR\fR
  65 .ad
  66 .RS 9n
  67 Is the number of characters whose rendition is to be changed.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIattr\fR\fR
  74 .ad
  75 .RS 9n
  76 Is the set of attributes to be assigned to the characters.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIcolor\fR\fR
  83 .ad
  84 .RS 9n
  85 Is the new color pair to be assigned to the characters.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIopts\fR\fR
  92 .ad
  93 .RS 9n
  94 Is reserved for future use.   Currently, this must be a null pointer.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fIy\fR\fR
 101 .ad
 102 .RS 9n
 103 Is the y (row) coordinate of the starting position in the window.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fIx\fR\fR
 110 .ad
 111 .RS 9n
 112 Is the x (column) coordinate of the starting position in the window. changed in
 113 the window.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fIwin\fR\fR
 120 .ad
 121 .RS 9n
 122 Is a pointer to the window in which the rendition of characters is to be
 123 changed.
 124 .RE
 125
 126 .SH RETURN VALUES
 127 .sp
 128 .LP
 129  Upon successful completion, these functions returned \fBOK\fR. Otherwise, they
 130 return \fBERR\fR.
 131 .SH ERRORS
 132 .sp
 133 .LP
 134 No errors are defined.
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .sp
 140
 141 .sp
 142 .TS
 143 box;
 144 c | c
 145 l | l .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 _
 148 Interface Stability     Standard
 149 _
 150 MT-Level        Unsafe
 151 .TE
 152
 153 .SH SEE ALSO
 154 .sp
 155 .LP
 156 \fBbkgrnd\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBsetcchar\fR(3XCURSES),
 157 \fBattributes\fR(5), \fBstandards\fR(5)