X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_addch.3x;h=68667d9f630e037a866c2ea095361c53232de562;hp=ee980aac54351729d7ef80b2744d6b7d6987d147;hb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;hpb=d97989d1e0db7282c723cabb44b991b951790006 diff --git a/man/curs_addch.3x b/man/curs_addch.3x index ee980aac..68667d9f 100644 --- a/man/curs_addch.3x +++ b/man/curs_addch.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2015,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,7 +28,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addch.3x,v 1.50 2019/11/30 20:07:00 tom Exp $ +.\" $Id: curs_addch.3x,v 1.54 2020/10/17 23:02:40 tom Exp $ .TH curs_addch 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -54,7 +55,7 @@ \fBint mvaddch(int y, int x, const chtype ch);\fR .br \fBint mvwaddch(WINDOW *win, int y, int x, const chtype ch);\fR -.br +.sp \fBint echochar(const chtype ch);\fR .br \fBint wechochar(WINDOW *win, const chtype ch);\fR @@ -93,11 +94,12 @@ scrolling the window if on the last line. Tabs are considered to be at every eighth column. The tab interval may be altered by setting the \fBTABSIZE\fR variable. .PP -If \fIch\fR is any other control character, it -is drawn in \fB^\fR\fIX\fR notation. +If \fIch\fR is any other nonprintable character, +it is drawn in printable form, +i.e., the \fB^\fR\fIX\fR notation used by \fBunctrl\fR(3X). Calling \fBwinch\fR after adding a -control character does not return the character itself, but instead returns -the ^-representation of the control character. +nonprintable character does not return the character itself, +but instead returns the printable representation of the character. .PP Video attributes can be combined with a character argument passed to \fBaddch\fR or related functions by logical-ORing them into the character. @@ -174,6 +176,19 @@ unless otherwise noted in the preceding routine descriptions. 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 +If it is not possible to add a complete character, +an error is returned: +.bP +If \fBscrollok\fR is not enabled, +writing a character at the lower right margin succeeds. +However, an error is returned because +it is not possible to wrap to a new line +.bP +If an error is detected when converting a multibyte character to a sequence +of bytes, +or if it is not possible to add all of the resulting bytes in the window, +an error is returned. .SH NOTES Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and \fBechochar\fR may be macros.