doc/html/man/mitem_current.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2022,2023 Thomas E. Dickey                                *
   4   * Copyright 1998-2006,2010 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: mitem_current.3x,v 1.33 2023/10/07 21:19:07 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>mitem_current 3x 2023-10-07 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">mitem_current 3x 2023-10-07 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>                Library calls               <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>mitem_current</STRONG> - set and get current_menu_item
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>set_current_item(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
  57        <STRONG>ITEM</STRONG> <STRONG>*current_item(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
  58
  59        <STRONG>int</STRONG> <STRONG>set_top_row(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>row</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>top_row(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
  61
  62        <STRONG>int</STRONG> <STRONG>item_index(const</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
  63
  64
  65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The  function <STRONG>set_current_item</STRONG> sets the current item (the item on which
  67        the menu cursor is positioned).  <STRONG>current_item</STRONG> returns a pointer to  the
  68        current item in the given menu.
  69
  70        The function <STRONG>set_top_row</STRONG> sets the top row of the menu to show the given
  71        row (the top row is initially 0, and is reset to  this  value  whenever
  72        the  <STRONG>O_ROWMAJOR</STRONG> option is toggled).  The item leftmost on the given row
  73        becomes current.  The function <STRONG>top_row</STRONG> returns the number  of  the  top
  74        menu row being displayed.
  75
  76        The  function <STRONG>item_index</STRONG> returns the (zero-origin) index of <EM>item</EM> in the
  77        menu's item pointer list.
  78
  79
  80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  81        <STRONG>current_item</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>).  It  does  not  set
  82        <STRONG>errno</STRONG>.
  83
  84        <STRONG>top_row</STRONG>  and  <STRONG>item_index</STRONG> return <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> error value) if
  85        their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
  86
  87        <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the following:
  88
  89        <STRONG>E_OK</STRONG> The routine succeeded.
  90
  91        <STRONG>E_BAD_ARGUMENT</STRONG>
  92             Routine detected an incorrect or out-of-range argument.
  93
  94        <STRONG>E_BAD_STATE</STRONG>
  95             Routine was called from an initialization or termination function.
  96
  97        <STRONG>E_NOT_CONNECTED</STRONG>
  98             No items are connected to the menu.
  99
 100        <STRONG>E_SYSTEM_ERROR</STRONG>
 101             System error occurred (see <STRONG>errno(3)</STRONG>).
 102
 103
 104 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 105        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 106        <STRONG>&lt;curses.h&gt;</STRONG>.
 107
 108
 109 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 110        These  routines  emulate  the  System  V  menu  library.  They were not
 111        supported on Version 7 or BSD versions.
 112
 113        The  SVr4  menu  library  documentation  specifies  the   <STRONG>top_row</STRONG>   and
 114        <STRONG>index_item</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
 115
 116
 117 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 118        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 119        Raymond.
 120
 121
 122 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 123        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
 124
 125
 126
 127 ncurses 6.4                       2023-10-07                 <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
 128 </PRE>
 129 <div class="nav">
 130 <ul>
 131 <li><a href="#h2-NAME">NAME</a></li>
 132 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 133 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 134 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 135 <li><a href="#h2-NOTES">NOTES</a></li>
 136 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 137 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 138 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 139 </ul>
 140 </div>
 141 </BODY>
 142 </HTML>