ncurses 6.1 - patch 20190727

[ncurses.git] / man / curs_getcchar.3x

diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index f6ac298c5295175e8af91881dce6444385c294d3..01fc5f673c98ef033208591d1aa779ab872652af 100644 (file)
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2001-2009,2010 Free Software Foundation, Inc.              *
+.\" Copyright (c) 2001-2017,2019 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,10 +26,11 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getcchar.3x,v 1.14 2010/09/18 20:26:21 tom Exp $
+.\" $Id: curs_getcchar.3x,v 1.21 2019/03/24 00:59:45 tom Exp $

 .TH curs_getcchar 3X ""
 .de bP
 .TH curs_getcchar 3X ""
 .de bP

-.IP \(bu 4
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2

 ..
 .SH NAME
 \fBgetcchar\fP,
 ..
 .SH NAME
 \fBgetcchar\fP,


@@ -59,8 +60,9 @@
 .br
 .B "        short \fIcolor_pair\fP,"
 .br
 .br
 .B "        short \fIcolor_pair\fP,"
 .br

-.B "        void *\fIopts\fP );"
+.B "        const void *\fIopts\fP );"

 .SH DESCRIPTION
 .SH DESCRIPTION

+.SS getcchar

 .PP
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
 .PP
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.


@@ -88,6 +90,7 @@ Does not change the data referenced by
 \fIattrs\fP
 or
 \fIcolor_pair\fP
 \fIattrs\fP
 or
 \fIcolor_pair\fP

+.SS setcchar

 .PP
 The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
 by using:
 .PP
 The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
 by using:


@@ -108,15 +111,28 @@ Additional nonspacing characters are ignored.
 .IP
 The string may contain a single control character instead.
 In that case, no nonspacing characters are allowed.
 .IP
 The string may contain a single control character instead.
 In that case, no nonspacing characters are allowed.

-.SH NOTES
+.SH EXTENSIONS

 .PP
 .PP

-The \fIopts\fP argument is reserved for future use.
-Currently, an application must provide a null pointer as \fIopts\fP.
+X/Open Curses documents the \fIopts\fP argument as reserved for future use,
+saying that it must be null.
+This implementation 
+uses that parameter in ABI 6 for the functions which have a color-pair
+parameter to support extended color pairs:
+.bP
+For  functions  which modify the color, e.g., \fBsetcchar\fP,
+if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
+and used to  set  the  color pair instead of the \fBshort\fP pair parameter.
+.bP
+For functions which retrieve the color, e.g., \fBgetcchar\fP,
+if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
+and  used  to  retrieve  the color pair as an \fBint\fP value,
+in addition retrieving it via the standard pointer to \fBshort\fP parameter.
+.SH NOTES

 .PP
 The \fIwcval\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
 If \fIwcval\fP is constructed by any other means, the effect is unspecified.
 .PP
 The \fIwcval\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
 If \fIwcval\fP is constructed by any other means, the effect is unspecified.

-.SH RETURN VALUES
+.SH RETURN VALUE

 .PP
 When \fIwch\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
 .PP
 When \fIwch\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by


@@ -136,9 +152,3 @@ Functions:
 \fBcurs_color\fR(3X),
 \fBcurses\fR(3X),
 \fBwcwidth\fR(3).
 \fBcurs_color\fR(3X),
 \fBcurses\fR(3X),
 \fBwcwidth\fR(3).

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: