xref: /freebsd/contrib/ncurses/man/curs_move.3x (revision 7937bfbc0ca53fe7cdd0d54414f9296e273a518e)
***************************************************************************
Copyright 2018-2023,2024 Thomas E. Dickey *
Copyright 1998-2010,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_move.3x,v 1.40 2024/04/27 17:56:05 tom Exp $
curs_move 3X 2024-04-27 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
NAME
\%move, \%wmove - move cursor in a curses window
SYNOPSIS
#include <curses.h>

int move(int y, int x); int wmove(WINDOW *win, int y, int x);

DESCRIPTION
\%wmove relocates the cursor associated with the curses window win to line y and column x . The terminal's cursor does not move until \%refresh(3X) is called. The position ( y , x ) is relative to the upper left-hand corner of the window, which has coordinates (0, 0). \%ncurses(3X) describes the \%move variant of this function.
RETURN VALUE
These functions return OK on success and ERR on failure.

They fail if the position ( y , x ) is outside the window boundaries.

\%wmove fails if its \%WINDOW pointer argument is NULL .

NOTES
\%move may be implemented as a macro.
PORTABILITY
X/Open Curses, Issue 4 describes these functions.
SEE ALSO
\%curses(3X), \%curs_refresh(3X)