X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_move.3x;h=05917626287c5e9bf32dff0e3c65596d106bce69;hp=226595cca6d737092fa1ca3e1165b6245e5ea0e7;hb=HEAD;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/curs_move.3x b/man/curs_move.3x index 226595cc..c3b68e81 100644 --- a/man/curs_move.3x +++ b/man/curs_move.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" 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 * @@ -26,38 +27,62 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.14 2010/12/04 18:40:45 tom Exp $ -.TH curs_move 3X "" -.na -.hy 0 +.\" $Id: curs_move.3x,v 1.40 2024/04/27 17:56:05 tom Exp $ +.TH curs_move 3X 2024-04-27 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBmove\fR, -\fBwmove\fR \- move \fBcurses\fR window cursor -.ad -.hy +\fB\%move\fP, +\fB\%wmove\fP \- +move cursor in a \fIcurses\fR window .SH SYNOPSIS -\fB#include \fR -.sp -\fBint move(int y, int x);\fR -.br -\fBint wmove(WINDOW *win, int y, int x);\fR -.br +.nf +\fB#include +.PP +\fBint move(int \fIy\fP, int \fIx\fP); +\fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.fi .SH DESCRIPTION -These routines move the cursor associated with the window to line \fIy\fR and -column \fIx\fR. This routine does not move the physical cursor of the terminal -until \fBrefresh\fR is called. The position specified is relative to the upper -left-hand corner of the window, which is (0,0). +.B \%wmove +relocates the cursor associated with the +.I curses +window +.I win +to line +.I y +and column +.IR x . +The terminal's cursor does not move until \fB\%refresh\fP(3X) is called. +The position +.RI ( y , +.IR x ) +is relative to the upper left-hand corner of the window, +which has coordinates +(0,\ 0). +\fB\%ncurses\fP(3X) describes the +.B \%move +variant of this function. .SH RETURN VALUE -These routines return \fBERR\fR upon failure and OK (SVr4 -specifies only "an integer value other than \fBERR\fR") upon successful -completion. +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +They fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP -Specifically, they return an error -if the window pointer is null, or -if the position is outside the window. +.B \%wmove +fails if its +.I \%WINDOW +pointer argument is +.BR NULL . .SH NOTES -Note that \fBmove\fR may be a macro. +.B \%move +may be implemented as a macro. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_refresh\fR(3X) +\fB\%curses\fP(3X), +\fB\%curs_refresh\fP(3X)