]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/mitem_current.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 5.9 - patch 20130518
[ncurses.git] / doc / html / man / mitem_current.3x.html
diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html
index ab74dffb56f82a9eb3495be6b4ee651abd5341e5..964aa9d7cf8d7eff81be8b8506c53ff6871fbff2 100644 (file)
--- a/doc/html/man/mitem_current.3x.html
+++ b/doc/html/man/mitem_current.3x.html
@@ -1,16 +1,59 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!-- 
+  * t
+  ****************************************************************************
+  * Copyright (c) 1998-2006,2010 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            *
+  * "Software"), to deal in the Software without restriction, including      *
+  * without limitation the rights to use, copy, modify, merge, publish,      *
+  * distribute, distribute with modifications, sublicense, and/or sell       *
+  * copies of the Software, and to permit persons to whom the Software is    *
+  * furnished to do so, subject to the following conditions:                 *
+  *                                                                          *
+  * The above copyright notice and this permission notice shall be included  *
+  * in all copies or substantial portions of the Software.                   *
+  *                                                                          *
+  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+  *                                                                          *
+  * Except as contained in this notice, the name(s) of the above copyright   *
+  * holders shall not be used in advertising or otherwise to promote the     *
+  * sale, use or other dealings in this Software without prior written       *
+  * authorization.                                                           *
+  ****************************************************************************
+  * @Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp @
+-->
 <HTML>
 <HTML>
+<HEAD>
+<TITLE>mitem_current 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
 <BODY>
 <BODY>
+<H1>mitem_current 3x</H1>
+<HR>
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>                                     <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
+
+
+
 
 </PRE>
 <H2>NAME</H2><PRE>
 
 </PRE>
 <H2>NAME</H2><PRE>
-       <B>mitem_current</B> - set and get current_menu_item
+       <STRONG>mitem_current</STRONG> - set and get current_menu_item
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;menu.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
        int set_current_item(MENU *menu, const ITEM *item);
        ITEM *current_item(const MENU *menu);
        int set_top_row(MENU *menu, int row);
        int set_current_item(MENU *menu, const ITEM *item);
        ITEM *current_item(const MENU *menu);
        int set_top_row(MENU *menu, int row);
@@ -20,113 +63,79 @@
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
-       The  function  <B>set_current_item</B> sets the current item (the
-       item on  which  the  menu  cursor  is  positioned).   <B>cur-</B>
-       <B>rent_item</B>  returns  a  pointer  to the current item in the
+       The  function  <STRONG>set_current_item</STRONG> sets the current item (the
+       item on  which  the  menu  cursor  is  positioned).   <STRONG>cur-</STRONG>
+       <STRONG>rent_item</STRONG>  returns  a  pointer  to the current item in the
        given menu.
 
        given menu.
 
-       The function <B>set_top_row</B> sets the top row of the  menu  to
+       The function <STRONG>set_top_row</STRONG> sets the top row of the  menu  to
        show  the  given  row  (the top row is initially 0, and is
        show  the  given  row  (the top row is initially 0, and is
-       reset to this value whenever the <B>O_ROWMAJOR</B> option is tog-
+       reset to this value whenever the <STRONG>O_ROWMAJOR</STRONG> option is tog-
        gled).   The  item  leftmost on the given row becomes cur-
        gled).   The  item  leftmost on the given row becomes cur-
-       rent.  The function <B>top_row</B> returns the number of the  top
+       rent.  The function <STRONG>top_row</STRONG> returns the number of the  top
        menu row being displayed.
 
        menu row being displayed.
 
-       The function <B>item_index</B> returns the (zero-origin) index of
-       <I>item</I> in the menu's item pointer list.
+       The function <STRONG>item_index</STRONG> returns the (zero-origin) index of
+       <EM>item</EM> in the menu's item pointer list.
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       <B>current_item</B> returns <B>NULL</B> on error.
+       <STRONG>current_item</STRONG> returns a pointer (which may  be  <STRONG>NULL</STRONG>).   It
+       does not set errno.
 
 
-       <B>top_row</B> and <B>item_index</B>  return  <B>ERR</B>  (the  general  <B>curses</B>
-       error value) on error.
+       <STRONG>top_row</STRONG>  and  <STRONG>item_index</STRONG>  return  <STRONG>ERR</STRONG>  (the general <STRONG>curses</STRONG>
+       error value) if their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
 
 
-       <B>set_current_item</B> and <B>set_top_row</B> return one of the follow-
+       <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow-
        ing:
 
        ing:
 
-       <B>E_OK</B> The routine succeeded.
-
-       <B>E_SYSTEM_ERROR</B>
-            System error occurred (see <B>errno</B>).
+       <STRONG>E_OK</STRONG> The routine succeeded.
 
 
-       <B>E_BAD_ARGUMENT</B>
-            Routine detected an incorrect or  out-of-range  argu-
+       <STRONG>E_BAD_ARGUMENT</STRONG>
+            Routine  detected  an incorrect or out-of-range argu-
             ment.
 
             ment.
 
-       <B>E_BAD_STATE</B>
+       <STRONG>E_BAD_STATE</STRONG>
             Routine was called from an initialization or termina-
             tion function.
 
             Routine was called from an initialization or termina-
             tion function.
 
-       <B>E_NOT_CONNECTED</B>
+       <STRONG>E_NOT_CONNECTED</STRONG>
             No items are connected to the menu.
 
             No items are connected to the menu.
 
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred (see <STRONG>errno</STRONG>).
+
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
-       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
-       The header file <B>&lt;menu.h&gt;</B> automatically includes the header
-       file <B>&lt;curses.h&gt;</B>.
+       The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
+       file <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       These  routines  emulate  the System V menu library.  They
+       These routines emulate the System V  menu  library.   They
        were not supported on Version 7 or BSD versions.
 
        were not supported on Version 7 or BSD versions.
 
-       The SVr4 menu library documentation specifies the  <B>top_row</B>
-       and  <B>index_item</B>  error  value as -1 (which is the value of
-       <B>ERR</B>).
+       The  SVr4 menu library documentation specifies the <STRONG>top_row</STRONG>
+       and <STRONG>index_item</STRONG> error value as -1 (which is  the  value  of
+       <STRONG>ERR</STRONG>).
 
 
 </PRE>
 <H2>AUTHORS</H2><PRE>
 
 
 </PRE>
 <H2>AUTHORS</H2><PRE>
-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
        curses by Eric S. Raymond.
 
 
 
        curses by Eric S. Raymond.
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+                                                      <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
 </PRE>
 <HR>
 <ADDRESS>
 </PRE>
 <HR>
 <ADDRESS>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/