X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_pattern.3x;h=faaf6475a8deb4228c0ceb5d31114f34c2d64b61;hb=414771292d2331e48bc09f49813998adc33929e2;hp=6b9fbccd1fa36381d5f8790595f14d43fcdcab0f;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x index 6b9fbccd..faaf6475 100644 --- a/man/menu_pattern.3x +++ b/man/menu_pattern.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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 * @@ -26,39 +27,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_pattern.3x,v 1.16 2018/07/28 22:08:59 tom Exp $ +.\" $Id: menu_pattern.3x,v 1.24 2022/02/12 20:02:20 tom Exp $ .TH menu_pattern 3X "" .SH NAME \fBset_menu_pattern\fP, -\fBmenu_pattern\fR \- set and get a menu's pattern buffer +\fBmenu_pattern\fP \- set and get a menu's pattern buffer .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_menu_pattern(MENU *\fImenu\fB, const char *\fIpattern\fB);\fR .br -int set_menu_pattern(MENU *menu, const char *pattern); -.br -char *menu_pattern(const MENU *menu); +\fBchar *menu_pattern(const MENU *\fImenu\fB);\fR .br .SH DESCRIPTION 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 \fBmenu_driver\fR(3X). +and tested for a match, as described in \fBmenu_driver\fP(3X). .PP -The function \fBset_menu_pattern\fR sets the pattern buffer for the given menu +The function \fBset_menu_pattern\fP 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. .PP -The function \fBmenu_pattern\fR returns the pattern buffer of the given -\fImenu\fR. +The function \fBmenu_pattern\fP returns the pattern buffer of the given +\fImenu\fP. .SH RETURN VALUE -The function \fBmenu_pattern\fR returns a pointer, -which is \fBNULL\fR if the \fImenu\fP parameter is \fBNULL\fP. +The function \fBmenu_pattern\fP returns a pointer, +which is \fBNULL\fP if the \fImenu\fP parameter is \fBNULL\fP. Otherwise, it is a pointer to a string which is empty if no pattern has been set. -It does not set errno. +It does not set \fBerrno\fP. .PP -The function \fBset_menu_pattern\fR may return the following error codes: +The function \fBset_menu_pattern\fP may return the following error codes: .TP 5 .B E_OK The routine succeeded. @@ -76,12 +77,12 @@ No items are connected to menu. Character failed to match. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on