usr/src/man/man3xcurses/ripoffline.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 RIPOFFLINE 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 ripoffline \- reserve screen line for dedicated purpose
   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 \fBripoffline\fR(\fBint\fR \fIline\fR, \fBint (*init)(WINDOW *\fR\fIwin\fR, \fBint\fR \fIwidth\fR));
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIline\fR\fR
  27 .ad
  28 .RS 9n
  29 determines whether the screen line being reserved comes from the top of
  30 \fBstdscr\fR (\fBline\fR is positive) or the bottom (\fBline\fR is negative).
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIinit\fR\fR
  37 .ad
  38 .RS 9n
  39 Is a pointer to a function that initializes the one-line window.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIwin\fR\fR
  46 .ad
  47 .RS 9n
  48 Is a pointer to one-line window created by this function.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIwidth\fR\fR
  55 .ad
  56 .RS 9n
  57 Is the number of columns in the window pointed to by the \fIwin\fR parameter.
  58 .RE
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 The \fBripoffline()\fR function reserves a screen line as a one line window.
  64 .sp
  65 .LP
  66 To use this function, it must be called before you call \fBinitscr\fR(3XCURSES)
  67 or \fBnewterm\fR(3XCURSES). When \fBinitscr()\fR or \fBnewterm()\fR is called,
  68 so is the function pointed to by \fBinit\fR. The function pointed to by
  69 \fBinit\fR takes two arguments: a pointer to the one-line window and the number
  70 of columns in that window. This function cannot use the \fBLINES\fR or
  71 \fBCOLS\fR variables and cannot call \fBwrefresh\fR(3XCURSES) or
  72 \fBdoupdate\fR(3XCURSES), but may call  \fBwnoutrefresh\fR(3XCURSES).
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 The \fBrioffline()\fR function always returns \fBOK\fR.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 None.
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Standard
  95 _
  96 MT-Level        Unsafe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBdoupdate\fR(3XCURSES), \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 103 \fBslk_attroff\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)