usr/src/man/man3xcurses/bkgrnd.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 BKGRND 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd \- set or get the
   9 background character (and rendition) of window using a complex character
  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 \fBbkgrnd\fR(\fBconst cchar_t *\fR\fIwch\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBbkgrndset\fR(\fBconst cchar_t *\fR\fIwch\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBgetbkgrnd\fR(\fBcchar_t *\fR\fIwch\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBwbkgrnd\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBvoid\fR \fBwbkgrndset\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBwgetbkgrnd\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwch\fR);
  46 .fi
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions turn off the previous
  52 background attributes, logical OR the requested attributes into the window
  53 rendition, and set the background property of the current or specified window
  54 based on the information in \fIwch\fR.
  55 .sp
  56 .LP
  57 The \fBbkgrnd()\fR and \fBwbkgrnd()\fR functions turn off the previous
  58 background attributes, logical OR the requested attributes into the window
  59 rendition, and set the background property of the current or specified window
  60 and then apply this setting to every character position in that window:
  61 .RS +4
  62 .TP
  63 .ie t \(bu
  64 .el o
  65 The rendition of every character on the screen is changed to the new window
  66 rendition.
  67 .RE
  68 .RS +4
  69 .TP
  70 .ie t \(bu
  71 .el o
  72 Wherever the former background character appears, it is changed to the new
  73 background character.
  74 .RE
  75 .sp
  76 .LP
  77 If \fIwch\fR refers to a non-spacing complex character for \fBbkgrnd()\fR,
  78 \fBbkgrndset()\fR, \fBwbkgrnd()\fR, and \fBwbkgrndset()\fR, then \fIwch\fR is
  79 added to the existing spacing complex character that is the background
  80 character. If \fIwch\fR refers to a multi-column character, the results are
  81 unspecified.
  82 .sp
  83 .LP
  84 The \fBgetbkgrnd()\fR and \fBwgetbkgrnd()\fR functions store, into the area
  85 pointed to buy \fIwch\fR, the window's background character and rendition.
  86 .SH PARAMETERS
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIwch\fR\fR
  91 .ad
  92 .RS 7n
  93 Is a pointer to the complex background character to be set.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIwin\fR\fR
 100 .ad
 101 .RS 7n
 102 Is a pointer to the window in which the complex background character is to  be
 103 set.
 104 .RE
 105
 106 .SH RETURN VALUES
 107 .sp
 108 .LP
 109 The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions do not return a value.
 110 .sp
 111 .LP
 112 Upon successful completion, the other functions return \fBOK\fR. Otherwise,
 113 they return \fBERR\fR.
 114 .SH ERRORS
 115 .sp
 116 .LP
 117 No errors are defined.
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Standard
 132 _
 133 MT-Level        Unsafe
 134 .TE
 135
 136 .SH SEE ALSO
 137 .sp
 138 .LP
 139 \fBadd_wch\fR(3XCURSES), \fBadd_wchnstr\fR(3XCURSES), \fBaddch\fR(3XCURSES),
 140 \fBaddchstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBbkgd\fR(3XCURSES),
 141 \fBclear\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES), \fBclrtobot\fR(3XCURSES),
 142 \fBerase\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 143 \fBmvprintw\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)