ncurses 5.7 - patch 20110115
[ncurses.git] / man / curs_getcchar.3x
index 91b996197c58bb448920a6330ffb07a0e1196436..1b878f313c2dc84b58e5c189d6ae97ddf7aba8e4 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2001-2003,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 2001-2009,2010 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_getcchar.3x,v 1.8 2006/07/15 22:51:07 wcmbrine Exp $
+.\" $Id: curs_getcchar.3x,v 1.15 2010/12/04 18:36:44 tom Exp $
 .TH curs_getcchar 3X ""
+.de bP
+.IP \(bu 4
+..
 .SH NAME
 \fBgetcchar\fP,
 \fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string
@@ -63,17 +66,13 @@ The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
 When \fIwch\fP is not a null pointer,
 the \fBgetcchar\fP function does the following:
-.TP 5
--
+.bP
 Extracts information from a \fBcchar_t\fP value \fIwcval\fP
-.TP 5
--
+.bP
 Stores the character attributes in the location pointed to by \fIattrs\fP
-.TP 5
--
+.bP
 Stores the color-pair in the location pointed to by \fIcolor_pair\fP
-.TP 5
--
+.bP
 Stores the wide-character string,
 characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP.
 .PP
@@ -82,11 +81,9 @@ When
 is a null pointer, the
 \fBgetcchar\fP
 function does the following:
-.TP 5
--
+.bP
 Obtains the number of wide characters pointed to by \fIwcval\fP
-.TP 5
--
+.bP
 Does not change the data referenced by
 \fIattrs\fP
 or
@@ -94,21 +91,23 @@ or
 .PP
 The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
 by using:
-.TP 5
--
+.bP
 The character attributes in
 \fIattrs\fP
-.TP 5
--
+.bP
 The color pair in
 \fIcolor_pair\fP
-.TP 5
--
+.bP
 The wide-character string pointed to by \fIwch\fP.
 The string must be L'\\0' terminated,
-contain at most one character with strictly positive width,
-which must be the first,
-and contain no characters of negative width.
+contain at most one spacing character,
+which must be the first.
+.IP
+Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow.
+Additional nonspacing characters are ignored.
+.IP
+The string may contain a single control character instead.
+In that case, no nonspacing characters are allowed.
 .SH NOTES
 .PP
 The \fIopts\fP argument is reserved for future use.
@@ -121,7 +120,8 @@ If \fIwcval\fP is constructed by any other means, the effect is unspecified.
 .PP
 When \fIwch\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
-\fIwcval\fP.
+\fIwcval\fP,
+including one for a trailing null.
 .PP
 When \fIwch\fP is not a null pointer,
 \fBgetcchar\fP returns \fBOK\fP upon successful completion,
@@ -132,13 +132,7 @@ Otherwise, it returns \fBERR\fP.
 .SH SEE ALSO
 .PP
 Functions:
+\fBcurs_attr\fR(3X),
+\fBcurs_color\fR(3X),
 \fBcurses\fR(3X),
-\fBwcwidth\fR(3X),
-\fBcurs_attr_get\fR(3X),
-\fBcan_change_color\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBwcwidth\fR(3).