chgat(3xcurses)

1chgat(3XCURSES)         X/Open Curses Library Functions        chgat(3XCURSES)
2
3
4

NAME

6       chgat,  mvchgat,  mvwchgat, wchgat - change the rendition of characters
7       in a window
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int chgat(int n, attr_t attr, short color, const void *opts);
18
19
20       int mvchgat(int y, int x, int n, attr_t attr, short color,
21            const void *opts);
22
23
24       int mvwchgat(WINDOW *win, int y, int x, int n, attr_t attr,
25            short color, const void *opts);
26
27
28       int wchgat(WINDOW *win, int n, attr_t attr, short color,
29            const void *opts);
30
31

DESCRIPTION

33       These  functions change the renditions of the next n characters in  the
34       current or specified window (or of the remaining characters on the cur‐
35       rent or specified line, if n is −1),  beginning at the current or spec‐
36       ified  cursor position. The attributes and colors are specified by attr
37       and color as for setcchar(3XCURSES).
38
39
40       These function neither update the cursor nor perform wrapping.
41
42
43       A value of n that is greater than the remaining  characters on  a  line
44       is not an error.
45
46
47       The  opts argument is reserved for definition in a future release. Cur‐
48       rently, the application must provide a null pointer for opts.
49

PARAMETERS

51       n        Is the number of characters whose rendition is to be changed.
52
53
54       attr     Is the set of attributes to be assigned to the characters.
55
56
57       color    Is the new color pair to be assigned to the characters.
58
59
60       opts     Is reserved for future use.   Currently, this must be  a  null
61                pointer.
62
63
64       y        Is the y (row) coordinate of the starting position in the win‐
65                dow.
66
67
68       x        Is the x (column) coordinate of the starting position  in  the
69                window. changed in the window.
70
71
72       win      Is  a  pointer to the window in which the rendition of charac‐
73                ters is to be  changed.
74
75

RETURN VALUES

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

ERRORS

81       No errors are defined.
82

ATTRIBUTES

84       See attributes(5) for descriptions of the following attributes:
85
86
87
88
89       ┌─────────────────────────────┬─────────────────────────────┐
90       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
91       ├─────────────────────────────┼─────────────────────────────┤
92       │Interface Stability          │Standard                     │
93       ├─────────────────────────────┼─────────────────────────────┤
94       │MT-Level                     │Unsafe                       │
95       └─────────────────────────────┴─────────────────────────────┘
96