xref: /illumos-gate/usr/src/man/man3xcurses/chgat.3xcurses (revision 1a2d662a91cee3bf82f41cd47c7ae6f3825d9db2)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
CHGAT 3XCURSES "Jun 5, 2002"
NAME
chgat, mvchgat, mvwchgat, wchgat - change the rendition of characters in a window
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int chgat(int n, attr_t attr, short color, const void *opts);

int mvchgat(int y, int x, int n, attr_t attr, short color,
 const void *opts);

int mvwchgat(WINDOW *win, int y, int x, int n, attr_t attr,
 short color, const void *opts);

int wchgat(WINDOW *win, int n, attr_t attr, short color,
 const void *opts);
DESCRIPTION

These functions change the renditions of the next n characters in the current or specified window (or of the remaining characters on the current or specified line, if n is -1), beginning at the current or specified cursor position. The attributes and colors are specified by attr and color as for setcchar(3XCURSES).

These function neither update the cursor nor perform wrapping.

A value of n that is greater than the remaining characters on a line is not an error.

The opts argument is reserved for definition in a future release. Currently, the application must provide a null pointer for opts.

PARAMETERS
n

Is the number of characters whose rendition is to be changed.

attr

Is the set of attributes to be assigned to the characters.

color

Is the new color pair to be assigned to the characters.

opts

Is reserved for future use. Currently, this must be a null pointer.

y

Is the y (row) coordinate of the starting position in the window.

x

Is the x (column) coordinate of the starting position in the window. changed in the window.

win

Is a pointer to the window in which the rendition of characters is to be changed.

RETURN VALUES

Upon successful completion, these functions returned OK. Otherwise, they return ERR.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

bkgrnd (3XCURSES), libcurses (3XCURSES), setcchar (3XCURSES), attributes (7), standards (7)