xref: /illumos-gate/usr/src/man/man3curses/curs_inwch.3curses (revision d583b39bfb4e2571d3e41097c5c357ffe353ad45)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, 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]
CURS_INWCH 3CURSES "Dec 31, 1996"
NAME
curs_inwch, inwch, winwch, mvinwch, mvwinwch - get a wchar_t character and its attributes from a curses window
SYNOPSIS

cc [ flag ... ] file ... -lcurses [ library .. ]
#include <curses.h>

chtype inwch(void);

chtype winwch(WINDOW *win);

chtype mvinwch(int y, int x);

chtype mvwinwch(WINDOW *win, int y, int x);
DESCRIPTION

These routines return the wchar_t character, of type chtype, at the current position in the named window. If any attributes are set for that position, their values are OR-ed into the value returned. Constants defined in <curses.h> can be used with the logical AND (&) operator to extract the character or attributes alone.

"Attributes"

The following bit-masks may be AND-ed with characters returned by winwch().

A_WCHARTEXT Bit-mask to extract character
A_WATTRIBUTES Bit-mask to extract attributes
ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), attributes(5)

NOTES

The header file <curses.h> automatically includes the header files <stdio.h>, <unctrl.h> and <widec.h>.

Note that all of these routines may be macros.

None of these routines can use the color attribute in chtype.