usr/src/man/man3xcurses/border_set.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_SET 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 border_set, box_set, wborder_set \- use complex characters (and renditions) to
   9 draw borders
  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 \fBborder_set\fR(\fBconst cchar_t *\fR\fIls\fR, \fBconst cchar_t *\fR\fIrs\fR, \fBconst cchar_t *\fR\fIts\fR,
  21      \fBconst cchar_t *\fR\fIbs\fR, \fBconst cchar_t *\fR\fItl\fR, \fBconst cchar_t *\fR\fItr\fR,
  22      \fBconst cchar_t *\fR\fIbl\fR,\fBconst cchar_t *\fR\fIbr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBwborder_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIls\fR, \fBconst cchar_t *\fR\fIrs\fR,
  28      \fBconst cchar_t *\fR\fIts\fR,\fBconst cchar_t *\fR\fIbs\fR, \fBconst cchar_t *\fR\fItl\fR,
  29      \fBconst cchar_t *\fR\fItr\fR, \fBconst cchar_t *\fR\fIbl\fR,\fBconst cchar_t *\fR\fIbr\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBbox_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIverch\fR, \fBconst cchar_t *\fR\fIhorch\fR);
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBborder_set()\fR and \fBwborder_set()\fR functions draw a border around
  41 the specified window.  All parameters must be spacing complex characters with
  42 renditions. A parameter which is a null pointer is replaced by the default
  43 character.
  44 .sp
  45 .LP
  46 \fBConstant Values for Borders\fR
  47 .sp
  48
  49 .sp
  50 .TS
  51 box;
  52 c c c
  53 c c c .
  54 Constant Values for Borders
  55 _
  56 Parameter       Default Constant        Default Character
  57 _
  58 \fIverch \fR    \fBWACS_VLINE\fR        \fB|\fR
  59 \fIhorch \fR    \fBWACS_HLINE\fR        \fB-\fR
  60 \fBls\fR        \fBWACS_VLINE\fR        \fB|\fR
  61 \fIrs\fR        \fBWACS_VLINE\fR        \fB|\fR
  62 \fIts\fR        \fBWACS_HLINE\fR        \fB-\fR
  63 \fIbs\fR        \fBWACS_HLINE\fR        \fB-\fR
  64 \fIbl\fR        \fBWACS_BLCORNER\fR     \fB+\fR
  65 \fIbr\fR        \fBWACS_BRCORNER\fR     \fB+\fR
  66 \fItl\fR        \fBWACS_ULCORNER\fR     \fB+\fR
  67 \fBtr\fR        \fBWACS_URCORNER\fR     \fB+\fR
  68 .TE
  69
  70 .sp
  71 .LP
  72 The call
  73 .sp
  74 .in +2
  75 .nf
  76 \fBbox_set(\fR\fIwin\fR,
  77 \fIverch\fR, \fIhorch\fR)
  78 .fi
  79 .in -2
  80
  81 .sp
  82 .LP
  83 is a short form for
  84 .sp
  85 .in +2
  86 .nf
  87 \fBwborder(\fR\fIwin\fR,
  88 \fIverch\fR, \fIverch\fR,
  89 \fIhorch\fR, \fIhorch\fR, NULL,
  90 NULL, NULL, NULL)
  91 .fi
  92 .in -2
  93
  94 .sp
  95 .LP
  96 When the window is boxed, the bottom and top rows and right and left columns
  97 are unavailable for text.
  98 .SH PARAMETERS
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fIls\fR\fR
 103 .ad
 104 .RS 9n
 105 Is the character and rendition used for the left side of the border.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fIrs\fR\fR
 112 .ad
 113 .RS 9n
 114 Is the character and rendition used for the right side of the border.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fIts\fR\fR
 121 .ad
 122 .RS 9n
 123 Is the character and rendition used for the top of the border.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fIbs\fR\fR
 130 .ad
 131 .RS 9n
 132 Is the character and rendition used for the bottom of the border.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fItl\fR\fR
 139 .ad
 140 .RS 9n
 141 Is the character and rendition used for the top-left corner of the border.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fItr\fR\fR
 148 .ad
 149 .RS 9n
 150 Is the character and rendition used for the top-right corner of the border.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fIbl\fR\fR
 157 .ad
 158 .RS 9n
 159 Is the character and rendition used for the bottom-left corner of the border.
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fIbr\fR\fR
 166 .ad
 167 .RS 9n
 168 Is the character and rendition used for the bottom-right corner of the border.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fIwin\fR\fR
 175 .ad
 176 .RS 9n
 177 Is the pointer to the window in which the border or box is to be drawn.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fIverch\fR\fR
 184 .ad
 185 .RS 9n
 186 Is the character and rendition used for the left and right columns of the box.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fIhorch\fR\fR
 193 .ad
 194 .RS 9n
 195 Is the character and rendition used for the top and bottom rows of the box.
 196 .RE
 197
 198 .SH RETURN VALUES
 199 .sp
 200 .LP
 201 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 202 .SH ERRORS
 203 .sp
 204 .LP
 205 None.
 206 .SH ATTRIBUTES
 207 .sp
 208 .LP
 209 See \fBattributes\fR(5) for descriptions of the following attributes:
 210 .sp
 211
 212 .sp
 213 .TS
 214 box;
 215 c | c
 216 l | l .
 217 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 218 _
 219 Interface Stability     Standard
 220 _
 221 MT-Level        Unsafe
 222 .TE
 223
 224 .SH SEE ALSO
 225 .sp
 226 .LP
 227 \fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBattr_get\fR(3XCURSES),
 228 \fBattroff\fR(3XCURSES), \fBborder\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 229 \fBattributes\fR(5), \fBstandards\fR(5)