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