.\"***************************************************************************
-.\" Copyright 2019-2022,2023 Thomas E. Dickey *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey *
.\" Copyright 2002-2011,2012 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_border_set.3x,v 1.20 2023/07/01 15:43:20 tom Exp $
-.TH curs_border_set 3X 2023-07-01 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el .ds '' ''
-.na
-.hy 0
+.\" $Id: curs_border_set.3x,v 1.38 2024/05/25 20:10:58 tom Exp $
+.TH curs_border_set 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el .ds `` ""
+.ie t .ds '' ''
+.el .ds '' ""
+.\}
.SH NAME
-\fBborder_set\fP,
-\fBwborder_set\fP,
-\fBbox_set\fP,
-\fBhline_set\fP,
-\fBwhline_set\fP,
-\fBmvhline_set\fP,
-\fBmvwhline_set\fP,
-\fBvline_set\fP,
-\fBwvline_set\fP,
-\fBmvvline_set\fP,
-\fBmvwvline_set\fP \- create \fBcurses\fP borders or lines using complex characters and renditions
-.ad
-.hy
+\fB\%border_set\fP,
+\fB\%wborder_set\fP,
+\fB\%box_set\fP,
+\fB\%hline_set\fP,
+\fB\%whline_set\fP,
+\fB\%mvhline_set\fP,
+\fB\%mvwhline_set\fP,
+\fB\%vline_set\fP,
+\fB\%wvline_set\fP,
+\fB\%mvvline_set\fP,
+\fB\%mvwvline_set\fP \-
+draw borders and lines in a \fIcurses\fR window of wide characters
.SH SYNOPSIS
-\fB#include <curses.h>\fP
-.sp
-\fBint border_set(\fP
- \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR,
- \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR,
- \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR,
- \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fR
-\fB);\fP
+.nf
+\fB#include <curses.h>
+.PP
+\fBint border_set(
+ \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
+ \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
+ \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
+ \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
.br
\fBint wborder_set(\fP
- \fBWINDOW *win\fP,
- \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR,
- \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR,
- \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR,
- \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fB);\fR
-.br
+ \fBWINDOW *\fIwin\fP,
+ \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
+ \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
+ \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
+ \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
\fBint box_set(\fP
- \fBWINDOW *win\fP,
- \fBconst cchar_t *\fIverch\fR,
+ \fBWINDOW *\fIwin\fP,
+ \fBconst cchar_t *\fIverch\fP,
\fBconst cchar_t *\fIhorch\fB);\fR
-.br
\fBint hline_set(\fP
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint whline_set(\fP
- \fBWINDOW *\fIwin\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBWINDOW *\fIwin\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint mvhline_set(\fP
- \fBint \fIy\fR, \fBint \fIx\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBint \fIy\fB, int \fIx\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint mvwhline_set(\fP
- \fBWINDOW *\fIwin\fR,
- \fBint \fIy\fR, \fBint \fIx\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBWINDOW *\fIwin\fP,
+ \fBint \fIy\fB, int \fIx\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint vline_set(\fP
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint wvline_set(\fP
- \fBWINDOW *\fIwin\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBWINDOW *\fIwin\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint mvvline_set(\fP
- \fBint \fIy\fR, \fBint \fIx\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+ \fBint \fIy\fB, int \fIx\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
\fBint mvwvline_set(\fP
- \fBWINDOW *\fIwin\fR,
- \fBint \fIy\fR, \fBint \fIx\fR,
- \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
+ \fBWINDOW *\fIwin\fP,
+ \fBint \fIy\fB, int \fIx\fP,
+ \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
+.fi
.SH DESCRIPTION
The
\fBborder_set\fP
\fBmvwvline_set\fP, and
\fBwvline_set\fP
functions draw a line proceeding toward the last line of the window.
-.br
+.SH RETURN VALUE
+Upon successful completion, these functions return
+\fBOK\fP.
+Otherwise, they return
+\fBERR\fP.
+.PP
+Functions using a window parameter return
+.B ERR
+if it is null.
+.PP
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
.SH NOTES
Note that
\fBborder_set\fP,
\fBmvwvline_set\fP, and
\fBvline_set\fP
may be macros.
-.SH RETURN VALUE
-Upon successful completion, these functions return
-\fBOK\fP.
-Otherwise, they return
-\fBERR\fP.
-.PP
-Functions using a window parameter return an error if it is null.
-.PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
-or if the window pointer is null.
+.SH PORTABILITY
+These functions are described in X/Open Curses, Issue 4.
.SH SEE ALSO
-\fBncurses\fP(3X),
-\fBcurs_add_wch\fP(3X),
-\fBcurs_border\fP(3X),
-\fBcurs_outopts\fP(3X)
+\fB\%curses\fP(3X),
+\fB\%curs_add_wch\fP(3X),
+\fB\%curs_border\fP(3X),
+\fB\%curs_outopts\fP(3X)
projects / ncurses.git / blobdiff