usr/src/man/man3xcurses/bkgd.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH BKGD 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 bkgd, bkgdset, getbkgd, wbkgd, wbkgdset \- set or get the background character
   9 (and rendition) of window
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBbkgd\fR(\fBchtype\fR \fIch\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBbkgdset\fR(\fBchtype\fR \fIch\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBchtype\fR \fBgetbkgd\fR(\fBWINDOW *\fR\fIwin\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBwbkgd\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBvoid\fR \fBwbkgdset\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR);
  41 .fi
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBbkgdset()\fR and \fBwbkgdset()\fR functions turn off the previous
  47 background attributes, logical OR the requested attributes into the window
  48 rendition, and set the background property of the current or specified window
  49 based on the information in \fIch\fR. If \fIch\fR refers to a multi-column
  50 character, the results are undefined.
  51 .sp
  52 .LP
  53 The \fBbkgd()\fR and \fBwbkgd()\fR functions turn off the previous background
  54 attributes, logical OR the requested attributes into the window rendition, and
  55 set the background property of the current or specified window and then apply
  56 this setting to every character position in that window:
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 The rendition of every character on the screen is changed to the new window
  62 rendition.
  63 .RE
  64 .RS +4
  65 .TP
  66 .ie t \(bu
  67 .el o
  68 Wherever the former background character appears, it is changed to the new
  69 background character.
  70 .RE
  71 .sp
  72 .LP
  73 The \fBgetbkgd()\fR function extracts the specified window's background
  74 character and rendition.
  75 .SH PARAMETERS
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIch\fR\fR
  80 .ad
  81 .RS 7n
  82 Is the background character to be set.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIwin\fR\fR
  89 .ad
  90 .RS 7n
  91 Is a pointer to the window in which the background character is to  be set.
  92 .RE
  93
  94 .SH RETURN VALUES
  95 .sp
  96 .LP
  97 Upon successful completion, the \fBbkgd()\fR and \fBwbkgd()\fR functions return
  98 \fBOK\fR. Otherwise, they return \fBERR\fR.
  99 .sp
 100 .LP
 101 The \fBbkgdset()\fR and \fBwbkgdset()\fR functions do not return a value.
 102 .sp
 103 .LP
 104 Upon successful completion, the \fBgetbkgd()\fR function returns the specified
 105 window's background character and rendition. Otherwise, it returns
 106 \fB(chtype)\fR\fBERR\fR.
 107 .SH ERRORS
 108 .sp
 109 .LP
 110 No errors are defined.
 111 .SH USAGE
 112 .sp
 113 .LP
 114 These functions are only guaranteed to operate reliably on character sets in
 115 which each character fits into a single byte, whose attributes can be expressed
 116 using only constants with the A_ prefix.
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 Interface Stability     Standard
 131 _
 132 MT-Level        Unsafe
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBaddch\fR(3XCURSES), \fBaddchstr\fR(3XCURSES), \fBattroff\fR(3XCURSES),
 139 \fBbkgrnd\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES),
 140 \fBclrtobot\fR(3XCURSES), \fBerase\fR(3XCURSES), \fBinch\fR(3XCURSES),
 141 \fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBattributes\fR(5),
 142 \fBstandards\fR(5)