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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2015 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: menu_pattern.3x,v 1.38 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>menu_pattern 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">menu_pattern 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>                 Library calls                <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>set_menu_pattern</STRONG>, <STRONG>menu_pattern</STRONG> - set and get a menu's pattern buffer
  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_menu_pattern(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>pattern</EM><STRONG>);</STRONG>
  57        <STRONG>char</STRONG> <STRONG>*menu_pattern(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        Every  menu  has  an  associated pattern match buffer.  As input events
  62        that are printable characters come in, they are appended to this  match
  63        buffer and tested for a match, as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>.
  64
  65        The  function  <STRONG>set_menu_pattern</STRONG>  sets  the pattern buffer for the given
  66        menu and tries to find the first matching item.  If it  succeeds,  that
  67        item becomes current; if not, the current item does not change.
  68
  69        The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of the given <EM>menu</EM>.
  70
  71
  72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  73        The  function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> if the <EM>menu</EM>
  74        parameter is <STRONG>NULL</STRONG>.  Otherwise, it is a pointer to  a  string  which  is
  75        empty if no pattern has been set.  It does not set <STRONG>errno</STRONG>.
  76
  77        The function <STRONG>set_menu_pattern</STRONG> may return the following error codes:
  78
  79        <STRONG>E_OK</STRONG> The routine succeeded.
  80
  81        <STRONG>E_BAD_ARGUMENT</STRONG>
  82             Routine detected an incorrect or out-of-range argument.
  83
  84        <STRONG>E_BAD_STATE</STRONG>
  85             Routine was called from an initialization or termination function.
  86
  87        <STRONG>E_NOT_CONNECTED</STRONG>
  88             No items are connected to menu.
  89
  90        <STRONG>E_NO_MATCH</STRONG>
  91             Character failed to match.
  92
  93        <STRONG>E_SYSTEM_ERROR</STRONG>
  94             System error occurred (see <STRONG>errno(3)</STRONG>).
  95
  96
  97 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  98        These  routines  emulate  the  System  V  menu  library.  They were not
  99        supported on Version 7 or BSD versions.
 100
 101
 102 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 103        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 104        Raymond.
 105
 106
 107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
 109
 110
 111
 112 ncurses 6.4                       2024-03-16                  <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG>
 113 </PRE>
 114 <div class="nav">
 115 <ul>
 116 <li><a href="#h2-NAME">NAME</a></li>
 117 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 118 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 119 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 120 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 121 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 123 </ul>
 124 </div>
 125 </BODY>
 126 </HTML>