usr/src/man/man3xcurses/mvcur.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 MVCUR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 mvcur \- move the 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 \fBmvcur\fR(\fBint\fR \fIoldrow\fR, \fBint\fR \fIoldcol\fR, \fBint\fR \fInewrow\fR, \fBint\fR \fInewcol\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIoldrow\fR\fR
  27 .ad
  28 .RS 10n
  29 Is the row from which cursor is to be moved.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIoldcol\fR\fR
  36 .ad
  37 .RS 10n
  38 Is the column from which cursor is to be moved.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fInewrow\fR\fR
  45 .ad
  46 .RS 10n
  47 Is the row to which cursor is to be moved.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fInewcol\fR\fR
  54 .ad
  55 .RS 10n
  56 Is the column to which cursor is to be moved.
  57 .RE
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBmvcur()\fR function is a low-level function used only outside of  X/Open
  63 Curses when the program has to deal directly with the \fBterminfo\fR database
  64 to handle certain terminal capabilities.  The use of appropriate X/Open Curses
  65 functions is recommended in all other  situations, so that X/Open Curses can
  66 track the cursor.
  67 .sp
  68 .LP
  69 The \fBmvcur()\fR function moves the cursor from the location specified by
  70 \fIoldrow\fR and \fIoldcol\fR to the location specified by \fInewrow\fR and
  71 \fInewcol\fR.  A program using this function must keep track of the current
  72 cursor position.
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 On success, the \fBmvcur()\fR function returns \fBOK\fR. Otherwise, it returns
  77 \fBERR\fR.
  78 .SH ERRORS
  79 .sp
  80 .LP
  81 None.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Standard
  96 _
  97 MT-Level        Unsafe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)