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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, 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 BORDER 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 border, box, wborder \- add a single-byte border to a window
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBborder\fR(\fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR, \fBchtype\fR \fItl\fR,
  20      \fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBwborder\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR,
  26      \fBchtype\fR \fItl\fR,\fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBint\fR \fBbox\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIverch\fR, \fBchtype\fR \fIhorch\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBborder()\fR and \fBwborder()\fR functions draw a border around the
  38 specified window.  All parameters must be single-byte characters whose
  39 rendition can be expressed using only constants beginning with \fBACS_\fR. A
  40 parameter with the value of 0 is replaced by the default value.
  41 .sp
  42
  43 .sp
  44 .TS
  45 box;
  46 c c c
  47 c c c .
  48 Constant Values for Borders
  49 _
  50 Parameter       Default Constant        Default Character
  51 _
  52 \fIverch \fR    \fBACS_VLINE\fR |
  53 \fIhorch \fR    \fBACS_HLINE\fR -
  54 \fBls\fR        \fBACS_VLINE\fR |
  55 \fIrs\fR        \fBACS_VLINE\fR |
  56 \fIts\fR        \fBACS_HLINE\fR -
  57 \fIbs\fR        \fBACS_HLINE\fR -
  58 \fIbl\fR        \fBACS_BLCORNER\fR      +
  59 \fIbr\fR        \fBACS_BRCORNER\fR      +
  60 \fItl\fR        \fBACS_ULCORNER\fR      +
  61 \fBtr\fR        \fBACS_URCORNER\fR      +
  62 .TE
  63
  64 .sp
  65 .LP
  66 The call
  67 .sp
  68 .in +2
  69 .nf
  70 \fBbox(\fR\fIwin\fR,
  71 \fIverch\fR, \fIhorch\fR)
  72 .fi
  73 .in -2
  74
  75 .sp
  76 .LP
  77 is a short form for
  78 .sp
  79 .in +2
  80 .nf
  81 \fBwborder(\fR\fIwin\fR,
  82 \fIverch\fR, \fIverch\fR,
  83 \fIhorch\fR, \fIhorch\fR, 0, 0, 0,
  84 0)
  85 .fi
  86 .in -2
  87
  88 .sp
  89 .LP
  90 When the window is boxed, the bottom and top rows and right and left columns
  91 overwrite existing text.
  92 .SH PARAMETERS
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fIls\fR\fR
  97 .ad
  98 .RS 9n
  99 Is the character and rendition used for the left side of the border.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fIrs\fR\fR
 106 .ad
 107 .RS 9n
 108 Is the character and rendition used for the right side of the border.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fIts\fR\fR
 115 .ad
 116 .RS 9n
 117 Is the character and rendition used for the top of the border.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIbs\fR\fR
 124 .ad
 125 .RS 9n
 126 Is the character and rendition used for the bottom of the border.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fItl\fR\fR
 133 .ad
 134 .RS 9n
 135 Is the character and rendition used for the top-left corner of the border.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fItr\fR\fR
 142 .ad
 143 .RS 9n
 144 Is the character and rendition used for the top-right corner of the border.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fIbl\fR\fR
 151 .ad
 152 .RS 9n
 153 Is the character and rendition used for the bottom-left corner of the border.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fIbr\fR\fR
 160 .ad
 161 .RS 9n
 162 Is the character and rendition used for the bottom-right corner of the border.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fIwin\fR\fR
 169 .ad
 170 .RS 9n
 171 Is the pointer to the window in which the border or box is to be drawn.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fIverch\fR\fR
 178 .ad
 179 .RS 9n
 180 Is the character and rendition used for the left and right columns of the box.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fIhorch\fR\fR
 187 .ad
 188 .RS 9n
 189 Is the character and rendition used for the top and bottom rows of the box.
 190 .RE
 191
 192 .SH RETURN VALUES
 193 .sp
 194 .LP
 195 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 196 .SH ERRORS
 197 .sp
 198 .LP
 199 None.
 200 .SH ATTRIBUTES
 201 .sp
 202 .LP
 203 See \fBattributes\fR(5) for descriptions of the following attributes:
 204 .sp
 205
 206 .sp
 207 .TS
 208 box;
 209 c | c
 210 l | l .
 211 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 212 _
 213 Interface Stability     Standard
 214 _
 215 MT-Level        Unsafe
 216 .TE
 217
 218 .SH SEE ALSO
 219 .sp
 220 .LP
 221 \fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBattr_get\fR(3XCURSES),
 222 \fBattroff\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 223 \fBattributes\fR(5), \fBstandards\fR(5)