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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2019,2020 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.21 2020/10/18 00:41:14 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</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">menu_pattern 3X</H1>
  43 <PRE>
  44 <B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B>                                              <B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <B>set_menu_pattern</B>, <B>menu_pattern</B> - set and get a menu's pattern buffer
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <B>#include</B> <B>&lt;menu.h&gt;</B>
  55
  56        <B>int</B> <B>set_menu_pattern(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>pattern</I><B>);</B>
  57        <B>char</B> <B>*menu_pattern(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
  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 <B><A HREF="menu_driver.3X.html">menu_driver(3X)</A></B>.
  64
  65        The  function  <B>set_menu_pattern</B>  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 <B>menu_pattern</B> returns the pattern buffer of the given <I>menu</I>.
  70
  71
  72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  73        The  function <B>menu_pattern</B> returns a pointer, which is <B>NULL</B> if the <I>menu</I>
  74        parameter is <B>NULL</B>.  Otherwise, it is a pointer to  a  string  which  is
  75        empty if no pattern has been set.  It does not set <B>errno</B>.
  76
  77        The function <B>set_menu_pattern</B> may return the following error codes:
  78
  79        <B>E_OK</B> The routine succeeded.
  80
  81        <B>E_BAD_ARGUMENT</B>
  82             Routine detected an incorrect or out-of-range argument.
  83
  84        <B>E_BAD_STATE</B>
  85             Routine was called from an initialization or termination function.
  86
  87        <B>E_NOT_CONNECTED</B>
  88             No items are connected to menu.
  89
  90        <B>E_NO_MATCH</B>
  91             Character failed to match.
  92
  93        <B>E_SYSTEM_ERROR</B>
  94             System error occurred (see <B>errno(3)</B>).
  95
  96
  97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  98        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
  99
 100
 101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 102        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
 103        <B>&lt;curses.h&gt;</B>.
 104
 105
 106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 107        These routines emulate the  System  V  menu  library.   They  were  not
 108        supported on Version 7 or BSD versions.
 109
 110
 111 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 112        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 113        Raymond.
 114
 115
 116
 117                                                               <B><A HREF="menu_pattern.3X.html">menu_pattern(3X)</A></B>
 118 </PRE>
 119 <div class="nav">
 120 <ul>
 121 <li><a href="#h2-NAME">NAME</a></li>
 122 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 123 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 124 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 125 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 126 <li><a href="#h2-NOTES">NOTES</a></li>
 127 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 128 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 129 </ul>
 130 </div>
 131 </BODY>
 132 </HTML>