8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3xcurses / move.3xcurses
blob246bc258f0b6093a337cd4ebef970017219252a4
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 MOVE 3XCURSES "Jun 5, 2002"
7 .SH NAME
8 move, wmove \- move cursor in window
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... ]
15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
17 #include <curses.h>
19 \fBint\fR \fBmove\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
20 .fi
22 .LP
23 .nf
24 \fBint\fR \fBwmove\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
25 .fi
27 .SH PARAMETERS
28 .sp
29 .ne 2
30 .na
31 \fB\fIy\fR\fR
32 .ad
33 .RS 7n
34 Is the y (row) coordinate of the position of the cursor in the window.
35 .RE
37 .sp
38 .ne 2
39 .na
40 \fB\fIx\fR\fR
41 .ad
42 .RS 7n
43 Is the x (column) coordinate of the position of the cursor in the window.
44 .RE
46 .sp
47 .ne 2
48 .na
49 \fB\fIwin\fR\fR
50 .ad
51 .RS 7n
52 Is a pointer to the window in which the cursor is to be written.
53 .RE
55 .SH DESCRIPTION
56 .sp
57 .LP
58 The \fBmove()\fR function moves the logical cursor (for \fBstdscr\fR) to the
59 position specified by \fIy\fR (row) and \fIx\fR (column), where the upper left
60 corner of the window is row 0, column 0.  The \fBwmove()\fR function performs
61 the same action, but moves the cursor  in the window specified by \fIwin\fR.
62 The physical cursor will not move until after a call to \fBrefresh\fR(3XCURSES)
63 or  \fBdoupdate\fR(3XCURSES).
64 .SH RETURN VALUES
65 .sp
66 .LP
67 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
68 .SH ERRORS
69 .sp
70 .LP
71 None.
72 .SH ATTRIBUTES
73 .sp
74 .LP
75 See \fBattributes\fR(5) for descriptions of the following attributes:
76 .sp
78 .sp
79 .TS
80 box;
81 c | c
82 l | l .
83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
85 Interface Stability     Standard
87 MT-Level        Unsafe
88 .TE
90 .SH SEE ALSO
91 .sp
92 .LP
93 \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
94 \fBstandards\fR(5)