X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_inch.3x;h=60bf4467a7fb42e61d04047159da0cb2fbf8047d;hb=3b56f70388c2ae65421ff54b45be77a479e79aea;hp=97eb981f43a270e88559bf5270660173d89f230b;hpb=06078d3fa68db669ed37178c01873546b4b28745;p=ncurses.git diff --git a/man/curs_inch.3x b/man/curs_inch.3x index 97eb981f..60bf4467 100644 --- a/man/curs_inch.3x +++ b/man/curs_inch.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,46 +28,52 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inch.3x,v 1.20 2017/11/18 23:47:37 tom Exp $ +.\" $Id: curs_inch.3x,v 1.27 2021/12/25 17:39:16 tom Exp $ .TH curs_inch 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBinch\fR, -\fBwinch\fR, -\fBmvinch\fR, -\fBmvwinch\fR \- get a character and attributes from a \fBcurses\fR window +\fBinch\fP, +\fBwinch\fP, +\fBmvinch\fP, +\fBmvwinch\fP \- get a character and attributes from a \fBcurses\fP window .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .sp -\fBchtype inch(void);\fR +\fBchtype inch(void);\fP .br -\fBchtype winch(WINDOW *win);\fR -.br -\fBchtype mvinch(int y, int x);\fR +\fBchtype winch(WINDOW *\fP\fIwin\fP\fB);\fP +.sp +\fBchtype mvinch(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fP .br -\fBchtype mvwinch(WINDOW *win, int y, int x);\fR +\fBchtype mvwinch(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fP .br .SH DESCRIPTION -These routines return the character, of type \fBchtype\fR, 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 -\fB\fR can be used with the \fB&\fR (logical AND) operator to +These routines return the character, of type \fBchtype\fP, 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 +\fB\fP can be used with the \fB&\fP (logical AND) operator to extract the character or attributes alone. . .SS Attributes -The following bit-masks may be AND-ed with characters returned by \fBwinch\fR. +The following bit-masks may be AND-ed with characters returned by \fBwinch\fP. . .TS l l . -\fBA_CHARTEXT\fR Bit-mask to extract character -\fBA_ATTRIBUTES\fR Bit-mask to extract attributes -\fBA_COLOR\fR Bit-mask to extract color-pair field information +\fBA_CHARTEXT\fP Bit-mask to extract character +\fBA_ATTRIBUTES\fP Bit-mask to extract attributes +\fBA_COLOR\fP Bit-mask to extract color-pair field information .TE .SH RETURN VALUE -Functions with a "mv" prefix first perform a cursor movement using +Functions with a \*(``mv\*('' prefix first perform a cursor movement using \fBwmove\fP, and return an error if the position is outside the window, or if the window pointer is null. .PP @@ -93,7 +100,7 @@ could be combined with characters in the window. Reflecting this improvement, the function was altered to return the character combined with all video attributes in a \fBchtype\fP value. .PP -X/Open Curses does not specify +X/Open Curses does not specify the size and layout of attributes, color and character values in \fBchtype\fP; it is implementation-dependent. This implementation uses 8 bits for character values. @@ -101,12 +108,12 @@ An application using more bits, e.g., a Unicode value, should use the wide-character equivalents to these functions. .SH SEE ALSO .TP 5 -\fBcurses\fR(3X) +\fBcurses\fP(3X) gives an overview of the WINDOW and \fBchtype\fP data types. .TP 5 -\fBcurs_attr\fR(3X) +\fBcurs_attr\fP(3X) goes into more detail, pointing out portability problems and constraints on the use of \fBchtype\fP for returning window information. .TP 5 -\fBcurs_in_wch\fR(3X) +\fBcurs_in_wch\fP(3X) describes comparable functions for the wide-character (ncursesw) library.