usr/src/man/man3xcurses/hline_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 HLINE_SET 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, vline_set,
   9 whline_set, wvline_set \- use complex characters (and renditions) to draw lines
  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 \fBhline_set\fR(\fBconst cchar_t *\fR\fIch\fR, \fBint\fR \fIn\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBmvhline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvvline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBvline_set\fR(\fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBhline_set()\fR, \fBvline_set()\fR, \fBwhline_set()\fR,
  62 \fBwvline_set()\fR functions draw a line, in either the window \fBstdscr\fR  or
  63 \fIwin\fR  starting at the current cursor position. The line is drawn using the
  64 character \fIwch\fR and is a maximum of \fIn\fR positions long, or as many as
  65 will fit into the window.  If \fIwch\fR is a null pointer, the default
  66 horizontal or vertical character is used.
  67 .sp
  68 .LP
  69 The \fBmvhline_set()\fR, \fBmvvline_set()\fR, \fBmvwhline_set()\fR,
  70 \fBmvwvline_set()\fR functions are similar to the previous group of functions
  71 but the line begins at cursor position specified by \fIx\fR and \fIy\fR.
  72 .sp
  73 .LP
  74 The functions with names ending with \fBhline_set()\fR draw horizontal lines
  75 proceeding towards the last column of the same line. The functions with names
  76 ending with \fBvline_set()\fR draw vertical lines proceeding towards the last
  77 column of the same line.
  78 .sp
  79 .LP
  80 These functions do not change the position of the cursor.
  81 .SH PARAMETERS
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIwch\fR\fR
  86 .ad
  87 .RS 7n
  88 Is the complex character used to draw the line.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fIn\fR\fR
  95 .ad
  96 .RS 7n
  97 Is the maximum number of characters in the line.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIy\fR\fR
 104 .ad
 105 .RS 7n
 106 Is the y (row) coordinate for the start of the line.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fIx\fR\fR
 113 .ad
 114 .RS 7n
 115 Is the x (column) coordinate for the start of the line.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fIwin\fR\fR
 122 .ad
 123 .RS 7n
 124 Is a pointer to a window.
 125 .RE
 126
 127 .SH RETURN VALUES
 128 .sp
 129 .LP
 130 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 131 .SH ERRORS
 132 .sp
 133 .LP
 134 None.
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .sp
 140
 141 .sp
 142 .TS
 143 box;
 144 c | c
 145 l | l .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 _
 148 Interface Stability     Standard
 149 _
 150 MT-Level        Unsafe
 151 .TE
 152
 153 .SH SEE ALSO
 154 .sp
 155 .LP
 156 \fBborder\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBhline\fR(3XCURSES),
 157 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)