diff options
Diffstat (limited to 'doc/html/man/menu_pattern.3x.html')
-rw-r--r-- | doc/html/man/menu_pattern.3x.html | 106 |
1 files changed, 51 insertions, 55 deletions
diff --git a/doc/html/man/menu_pattern.3x.html b/doc/html/man/menu_pattern.3x.html index 4d8d8c5..1be9d1b 100644 --- a/doc/html/man/menu_pattern.3x.html +++ b/doc/html/man/menu_pattern.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 1998-2010,2015 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 * @@ -27,71 +27,61 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ + * @Id: menu_pattern.3x,v 1.18 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>menu_pattern 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>menu_pattern 3x</H1> -<HR> +<H1 class="no-header">menu_pattern 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> +<STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>menu_pattern</STRONG> - get and set a menu's pattern buffer +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>set_menu_pattern</STRONG>, <STRONG>menu_pattern</STRONG> - set and get a menu's pattern buffer -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> int set_menu_pattern(MENU *menu, const char *pattern); char *menu_pattern(const MENU *menu); -</PRE> -<H2>DESCRIPTION</H2><PRE> - Every menu has an associated pattern match buffer. As - input events that are printable characters come in, they - are appended to this match buffer and tested for a match, - as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + Every menu has an associated pattern match buffer. As input events + that are printable characters come in, they are appended to this match + buffer and tested for a match, as described in <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>. - The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for - the given menu and tries to find the first matching item. - If it succeeds, that item becomes current; if not, the - current item does not change. + The function <STRONG>set_menu_pattern</STRONG> sets the pattern buffer for the given + menu and tries to find the first matching item. If it succeeds, that + item becomes current; if not, the current item does not change. - The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of - the given <EM>menu</EM>. + The function <STRONG>menu_pattern</STRONG> returns the pattern buffer of the given <EM>menu</EM>. -</PRE> -<H2>RETURN VALUE</H2><PRE> - The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> - if the <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer - to a string which is empty if no pattern has been set. It - does not set errno. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + The function <STRONG>menu_pattern</STRONG> returns a pointer, which is <STRONG>NULL</STRONG> if the <EM>menu</EM> + parameter is <STRONG>NULL</STRONG>. Otherwise, it is a pointer to a string which is + empty if no pattern has been set. It does not set errno. - The function <STRONG>set_menu_pattern</STRONG> may return the following - error codes: + The function <STRONG>set_menu_pattern</STRONG> may return the following error codes: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. <STRONG>E_BAD_STATE</STRONG> - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. <STRONG>E_NOT_CONNECTED</STRONG> No items are connected to menu. @@ -100,36 +90,42 @@ Character failed to match. <STRONG>E_SYSTEM_ERROR</STRONG> - System error occurred (see <STRONG>errno</STRONG>). + System error occurred (see <STRONG>errno(3)</STRONG>). -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <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> - The header file <STRONG><menu.h></STRONG> automatically includes the header - file <STRONG><curses.h></STRONG>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header file + <STRONG><curses.h></STRONG>. -</PRE> -<H2>PORTABILITY</H2><PRE> - These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These routines emulate the System V menu library. They were not sup- + ported on Version 7 or BSD versions. -</PRE> -<H2>AUTHORS</H2><PRE> - Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> + <STRONG><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></STRONG> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-AUTHORS">AUTHORS</a></li> +</ul> +</div> </BODY> </HTML> |