man/curs_move.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_move.3x,v 1.38 2024/04/20 19:51:33 tom Exp $
  31 .TH curs_move 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .SH NAME
  33 \fB\%move\fP,
  34 \fB\%wmove\fP \-
  35 move cursor in a \fIcurses\fR window
  36 .SH SYNOPSIS
  37 .nf
  38 \fB#include <curses.h>
  39 .PP
  40 \fBint move(int \fIy\fP, int \fIx\fP);
  41 \fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
  42 .fi
  43 .SH DESCRIPTION
  44 .B \%wmove
  45 relocates the cursor associated with the
  46 .I curses
  47 window
  48 .I win
  49 to line
  50 .I y
  51 and column
  52 .IR x .
  53 The terminal's cursor does not move until \fB\%refresh\fP(3X) is called.
  54 The position
  55 .RI ( x ,
  56 .IR y )
  57 is relative to the upper left-hand corner of the window,
  58 which has coordinates
  59 (0,\ 0).
  60 \fB\%ncurses\fP(3X) describes the
  61 .B \%move
  62 variant of this function.
  63 .SH RETURN VALUE
  64 These functions return
  65 .B OK
  66 on success and
  67 .B ERR
  68 on failure.
  69 .PP
  70 They fail if the position
  71 .RI ( y ,
  72 .IR x )
  73 is outside the window boundaries.
  74 .PP
  75 .B \%wmove
  76 fails if its
  77 .I \%WINDOW
  78 pointer argument is
  79 .BR NULL .
  80 .SH NOTES
  81 .B \%move
  82 may be implemented as a macro.
  83 .SH PORTABILITY
  84 X/Open Curses,
  85 Issue 4 describes these functions.
  86 .SH SEE ALSO
  87 \fB\%curses\fP(3X),
  88 \fB\%curs_refresh\fP(3X)