usr/src/man/man3curses/curs_border.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_BORDER 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_border, border, wborder, box, whline, wvline \- create curses borders,
  10 horizontal and vertical lines
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16
  17 \fBint\fR \fBborder\fR(\fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR, \fBchtype\fR \fItl\fR,
  18      \fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR,\fBchtype\fR \fIbr\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBwborder\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR,
  24      \fBchtype\fR \fIbs\fR, \fBchtype\fR \fItl\fR, \fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBbox\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIverch\fR, \fBchtype\fR \fIhorch\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBhline\fR(\fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR);
  35 .fi
  36
  37 .LP
  38 .nf
  39 \fBint\fR \fBwhline\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR);
  40 .fi
  41
  42 .LP
  43 .nf
  44 \fBint\fR \fBvline\fR(\fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR);
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBint\fR \fBwvline\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR);
  50 .fi
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 With the \fBborder()\fR, \fBwborder()\fR, and  \fBbox()\fR routines, a border
  56 is drawn around the edges of the window. The arguments and attributes are:
  57 .sp
  58
  59 .sp
  60 .TS
  61 l l
  62 l l .
  63 \fBls\fR        left side of the border
  64 \fBrs\fR        right side of the border
  65 \fBts\fR        top side of the border
  66 \fBbs\fR        bottom side of the border
  67 \fBtl\fR        top left-hand corner
  68 \fBtr\fR        top right-hand corner
  69 \fBbl\fR        bottom left-hand corner
  70 \fBbr\fR        bottom right-hand corner
  71 .TE
  72
  73 .sp
  74 .LP
  75 If any of these arguments is zero, then the following default values (defined
  76 in <\fBcurses.h\fR>) are used respectively instead: \fBACS_VLINE\fR,
  77 \fBACS_VLINE\fR, \fBACS_HLINE\fR, \fBACS_HLINE\fR, \fBACS_ULCORNER\fR,
  78 \fBACS_URCORNER\fR, \fBACS_BLCORNER\fR, \fBACS_BRCORNER\fR.
  79 .sp
  80 .LP
  81 \fBbox(\fR\fIwin\fR\fB,\fR \fIverch\fR\fB,\fR \fIhorch\fR\fB)\fR is a shorthand
  82 for the following call:
  83 .sp
  84 .LP
  85 \fBwborder(\fR\fIwin\fR\fB,\fR \fIverch\fR\fB,\fR \fIverch\fR\fB,\fR
  86 \fIhorch\fR\fB,\fR \fBhorch , 0, 0, 0, 0)\fR
  87 .sp
  88 .LP
  89 \fBhline()\fR and \fBwhline()\fR draw a horizontal (left to right) line using
  90 \fIch\fR starting at the current cursor position in the window. The current
  91 cursor position is not changed. The line is at most \fIn\fR characters long, or
  92 as many as fit into the window.
  93 .sp
  94 .LP
  95 \fBvline()\fR and \fBwvline()\fR draw a vertical (top to bottom) line using
  96 \fIch\fR starting at the current cursor position in the window. The current
  97 cursor position is not changed. The line is at most \fIn\fR characters long, or
  98 as many as fit into the window.
  99 .SH RETURN VALUES
 100 .sp
 101 .LP
 102 All routines return the integer \fBOK\fR, or a non-negative integer if
 103 \fBimmedok()\fR is set. See \fBcurs_outopts\fR(3CURSES).
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 MT-Level        Unsafe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBcurs_outopts\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5)
 124 .SH NOTES
 125 .sp
 126 .LP
 127 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
 128 and <\fBunctrl.h\fR>.
 129 .sp
 130 .LP
 131 Note that \fBborder()\fR and \fBbox()\fR may be macros.