doc/html/man/menu_pattern.3x.html

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