X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_opts.3x;h=ad7a392cb219b3f034759afaa6afce7aeb6e8754;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=4a0d435d41d38d23b0da130a111dd14d2eb1a8b7;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/menu_opts.3x b/man/menu_opts.3x index 4a0d435d..ad7a392c 100644 --- a/man/menu_opts.3x +++ b/man/menu_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,35 +27,35 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_opts.3x,v 1.17 2020/02/02 23:34:34 tom Exp $ -.TH menu_opts 3X "" +.\" $Id: menu_opts.3x,v 1.33 2023/11/25 13:58:47 tom Exp $ +.TH menu_opts 3X 2023-11-25 "ncurses 6.4" "Library calls" .SH NAME \fBset_menu_opts\fP, \fBmenu_opts_on\fP, \fBmenu_opts_off\fP, -\fBmenu_opts\fR \- set and get menu options +\fBmenu_opts\fP \- +set and get menu options .SH SYNOPSIS -\fB#include \fR -.br -int set_menu_opts(MENU *menu, Menu_Options opts); -.br -int menu_opts_on(MENU *menu, Menu_Options opts); -.br -int menu_opts_off(MENU *menu, Menu_Options opts); -.br -Menu_Options menu_opts(const MENU *menu); -.br +.nf +\fB#include +.PP +\fBint set_menu_opts(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +\fBMenu_Options menu_opts(const MENU *\fImenu\fP); +.PP +\fBint menu_opts_on(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +\fBint menu_opts_off(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +.fi .SH DESCRIPTION -The function \fBset_menu_opts\fR sets all the given menu's option bits (menu +The function \fBset_menu_opts\fP sets all the given menu's option bits (menu option bits may be logically-OR'ed together). .PP -The function \fBmenu_opts_on\fR turns on the given option bits, and leaves +The function \fBmenu_opts_on\fP turns on the given option bits, and leaves others alone. .PP -The function \fBmenu_opts_off\fR turns off the given option bits, and leaves +The function \fBmenu_opts_off\fP turns off the given option bits, and leaves others alone. .PP -The function \fBmenu_opts\fR returns the menu's current option bits. +The function \fBmenu_opts\fP returns the menu's current option bits. .PP The following options are defined (all are on by default): .TP 5 @@ -85,21 +84,16 @@ and it does not fall on the currently active menu, push \fBKEY_MOUSE\fP and the \fBMEVENT\fP data back on the queue to allow processing in another part of the calling program. .SH RETURN VALUE -Except for \fBmenu_opts\fR, each routine returns one of the following: +Except for \fBmenu_opts\fP, each routine returns one of the following: .TP 5 .B E_OK The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR(3)). +System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_POSTED The menu is already posted. -.SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -107,3 +101,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)