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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: mitem_current.3x,v 1.20 2020/10/18 00:39:06 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>mitem_current 3X</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">mitem_current 3X</H1>
  44 <PRE>
  45 <B><A HREF="mitem_current.3X.html">mitem_current(3X)</A></B>                                            <B><A HREF="mitem_current.3X.html">mitem_current(3X)</A></B>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <B>mitem_current</B> - set and get current_menu_item
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <B>#include</B> <B>&lt;menu.h&gt;</B>
  56
  57        <B>int</B> <B>set_current_item(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>ITEM</B> <B>*</B><I>item</I><B>);</B>
  58        <B>ITEM</B> <B>*current_item(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
  59
  60        <B>int</B> <B>set_top_row(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>int</B> <I>row</I><B>);</B>
  61        <B>int</B> <B>top_row(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
  62
  63        <B>int</B> <B>item_index(const</B> <B>ITEM</B> <B>*</B><I>item</I><B>);</B>
  64
  65
  66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  67        The  function <B>set_current_item</B> sets the current item (the item on which
  68        the menu cursor is positioned).  <B>current_item</B> returns a pointer to  the
  69        current item in the given menu.
  70
  71        The function <B>set_top_row</B> sets the top row of the menu to show the given
  72        row (the top row is initially 0, and is reset to  this  value  whenever
  73        the  <B>O_ROWMAJOR</B> option is toggled).  The item leftmost on the given row
  74        becomes current.  The function <B>top_row</B> returns the number  of  the  top
  75        menu row being displayed.
  76
  77        The  function <B>item_index</B> returns the (zero-origin) index of <I>item</I> in the
  78        menu's item pointer list.
  79
  80
  81 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  82        <B>current_item</B> returns a pointer (which may be <B>NULL</B>).  It  does  not  set
  83        <B>errno</B>.
  84
  85        <B>top_row</B>  and  <B>item_index</B> return <B>ERR</B> (the general <B>curses</B> error value) if
  86        their <I>menu</I> parameter is <B>NULL</B>.
  87
  88        <B>set_current_item</B> and <B>set_top_row</B> return one of the following:
  89
  90        <B>E_OK</B> The routine succeeded.
  91
  92        <B>E_BAD_ARGUMENT</B>
  93             Routine detected an incorrect or out-of-range argument.
  94
  95        <B>E_BAD_STATE</B>
  96             Routine was called from an initialization or termination function.
  97
  98        <B>E_NOT_CONNECTED</B>
  99             No items are connected to the menu.
 100
 101        <B>E_SYSTEM_ERROR</B>
 102             System error occurred (see <B>errno(3)</B>).
 103
 104
 105 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 106        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
 107
 108
 109 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 110        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
 111        <B>&lt;curses.h&gt;</B>.
 112
 113
 114 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 115        These  routines  emulate  the  System  V  menu  library.  They were not
 116        supported on Version 7 or BSD versions.
 117
 118        The  SVr4  menu  library  documentation  specifies  the   <B>top_row</B>   and
 119        <B>index_item</B> error value as -1 (which is the value of <B>ERR</B>).
 120
 121
 122 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 123        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 124        Raymond.
 125
 126
 127
 128                                                              <B><A HREF="mitem_current.3X.html">mitem_current(3X)</A></B>
 129 </PRE>
 130 <div class="nav">
 131 <ul>
 132 <li><a href="#h2-NAME">NAME</a></li>
 133 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 134 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 135 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 136 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 137 <li><a href="#h2-NOTES">NOTES</a></li>
 138 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 139 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 140 </ul>
 141 </div>
 142 </BODY>
 143 </HTML>