doc/html/man/curs_move.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_move.3x,v 1.35 2024/03/16 15:35:01 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_move 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_move 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>                    Library calls                   <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>move</STRONG>, <STRONG>wmove</STRONG> - move cursor in a <EM>curses</EM> window
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>move(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>wmove(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        These routines move the cursor associated with the window to line <EM>y</EM> and
  62        column <EM>x</EM>.  This routine does  not  move  the  physical  cursor  of  the
  63        terminal  until  <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>  is  called.   The  position  specified is
  64        relative to the upper left-hand corner of the window, which is (0,0).
  65
  66
  67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  68        These routines return the integer <STRONG>ERR</STRONG> upon  failure  and  an  <STRONG>OK</STRONG>  (SVr4
  69        specifies  only  "an  integer  value  other  than <STRONG>ERR</STRONG>") upon successful
  70        completion.
  71
  72        Specifically, they return an error if the window pointer is null, or if
  73        the position is outside the window.
  74
  75
  76 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  77        Note that <STRONG>move</STRONG> may be a macro.
  78
  79
  80 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  81        These functions are described in the XSI Curses standard, Issue 4.
  82
  83
  84 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  85        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
  86
  87
  88
  89 ncurses 6.4                       2024-03-16                     <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
  90 </PRE>
  91 <div class="nav">
  92 <ul>
  93 <li><a href="#h2-NAME">NAME</a></li>
  94 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
  95 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
  96 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
  97 <li><a href="#h2-NOTES">NOTES</a></li>
  98 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
  99 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 100 </ul>
 101 </div>
 102 </BODY>
 103 </HTML>