usr/src/man/man3xcurses/curs_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 CURS_SET 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 curs_set \- set visibility of cursor
   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 \fBcurs_set\fR(\fBint\fR \fIvisibility\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBcurs_set()\fR function sets the visibility of the cursor to  invisible
  26 (0), normal (1), or very visible (2).   The exact appearance of normal and very
  27 visible cursors is terminal dependent.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIvisibility\fR\fR
  33 .ad
  34 .RS 14n
  35 Is a value of 0 (invisible), 1 (normal), or 2 (very visible).
  36 .RE
  37
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 If the terminal supports the mode specified by the  \fIvisibility\fR parameter,
  42 the \fBcurs_set()\fR function returns the previous cursor state. Otherwise, it
  43 returns \fBERR\fR.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 None.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        Unsafe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)