Manual Pages for UNIX Darwin command on man wechochar

cursaddch(3X) cursaddch(3X)

NAME

aaddddcchh, wwaaddddcchh, mmvvaaddddcchh, mmvvwwaaddddcchh, eecchhoocchhaarr, wweecchhoocchhaarr - add a character

(with attributes) to a ccuurrsseess window, then advance the cursor

SYNOPSIS

##iinncclluuddee <>

iinntt aaddddcchh((ccoonnsstt cchhttyyppee cchh));; iinntt wwaaddddcchh((WWIINNDDOOWW **wwiinn,, ccoonnsstt cchhttyyppee cchh));; iinntt mmvvaaddddcchh((iinntt yy,, iinntt xx,, ccoonnsstt cchhttyyppee cchh));; iinntt mmvvwwaaddddcchh((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, ccoonnsstt cchhttyyppee cchh));; iinntt eecchhoocchhaarr((ccoonnsstt cchhttyyppee cchh));; iinntt wweecchhoocchhaarr((WWIINNDDOOWW **wwiinn,, ccoonnsstt cchhttyyppee cchh));;

DESCRIPTION

The aaddddcchh, wwaaddddcchh, mmvvaaddddcchh and mmvvwwaaddddcchh routines put the character ch into the given window at its current window position, which is then advanced. They are analogous to ppuuttcchhaarr in ssttddiioo(3). If the advance is at the right margin, the cursor automatically wraps to the beginning of the next line. At the bottom of the current scrolling region, if ssccrroollllookk is enabled, the scrolling region is scrolled up one line.

If ch is a tab, newline, or backspace, the cursor is moved appropri-

ately within the window. Backspace moves the cursor one character left; at the left edge of a window it does nothing. Newline does a ccllrrttooeeooll, then moves the cursor to the window left margin on the next line, 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 TTAABBSSIIZZEE variable. If ch is any control character other than tab, newline, or backspace,

it is drawn in ^^X notation. Calling wwiinncchh after adding a control char-

acter does not return the character itself, but instead returns the

^-representation of the control character.

Video attributes can be combined with a character argument passed to

aaddddcchh or related functions by logical-ORing them into the character.

(Thus, text, including attributes, can be copied from one place to another using iinncchh and aaddddcchh.) See the ccuurrssaattttrr(3X) page for values of predefined video attribute constants that can be usefully OR'ed into characters. The eecchhoocchhaarr and wweecchhoocchhaarr routines are equivalent to a call to aaddddcchh followed by a call to rreeffrreesshh, or a call to wwaaddddcchh followed by a call

to wwrreeffrreesshh. The knowledge that only a single character is being out-

put is used and, for non-control characters, a considerable performance

gain may be seen by using these routines instead of their equivalents. LLiinnee GGrraapphhiiccss The following variables may be used to add line drawing characters to the screen with routines of the aaddddcchh family. The default character

listed below is used if the aaccsscc capability doesn't define a terminal-

specific replacement for it (but see the EXTENSIONS section below). The names are taken from VT100 nomenclature. Name Default Description

-------------------------

ACSBLOCK # solid square block

ACSBOARD # board of squares

ACSBTEE + bottom tee ACSBULLET o bullet ACSCKBOARD : checker board (stipple) ACSDARROW v arrow pointing down ACSDEGREE ' degree symbol ACSDIAMOND + diamond

ACSGEQUAL > greater-than-or-equal-to

ACSHLINE - horizontal line

ACSLANTERN # lantern symbol

ACSLARROW < arrow pointing left

ACSLEQUAL < less-than-or-equal-to

ACSLLCORNER + lower left-hand corner

ACSLRCORNER + lower right-hand corner

ACSLTEE + left tee

ACSNEQUAL ! not-equal

ACSPI * greek pi

ACSPLMINUS # plus/minus

ACSPLUS + plus ACSRARROW > arrow pointing right ACSRTEE + right tee

ACSS1 - scan line 1

ACSS3 - scan line 3

ACSS7 - scan line 7

ACSS9 scan line 9

ACSSTERLING f pound-sterling symbol

ACSTTEE + top tee ACSUARROW ^ arrow pointing up

ACSULCORNER + upper left-hand corner

ACSURCORNER + upper right-hand corner

ACSVLINE | vertical line RREETTUURRNN VVAALLUUEE All routines return the integer EERRRR upon failure and OOKK on success (the

SVr4 manuals specify only "an integer value other than EERRRR") upon suc-

cessful completion, unless otherwise noted in the preceding routine descriptions. NNOOTTEESS Note that aaddddcchh, mmvvaaddddcchh, mmvvwwaaddddcchh, and eecchhoocchhaarr may be macros. PPOORRTTAABBIILLIITTYY All these functions are described in the XSI Curses standard, Issue 4.

The defaults specified for forms-drawing characters apply in the POSIX

locale. Some ACS symbols (ACSS3, ACSS7, ACSLEQUAL, ACSGEQUAL, ACSPI, ACSNEQUAL, ACSSTERLING) were not documented in any publicly released System V. However, many publicly available terminfos include aaccsscc strings in which their key characters (pryz{|}) are embedded, and a

second-hand list of their character descriptions has come to light.

The ACS-prefixed names for them were invented for nnccuurrsseess(3X).

The TTAABBSSIIZZEE variable is implemented in some versions of curses, but is not part of X/Open curses. If ch is a carriage return, the cursor is moved to the beginning of the current row of the window. This is true of other implementations, but is not documented.