diff options
Diffstat (limited to 'man/menu.3x')
| -rw-r--r-- | man/menu.3x | 60 |
1 files changed, 32 insertions, 28 deletions
diff --git a/man/menu.3x b/man/menu.3x index a833c3b55123..f86f3b5e606a 100644 --- a/man/menu.3x +++ b/man/menu.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2023,2024 Thomas E. Dickey * +.\" Copyright 2018-2024,2025 Thomas E. Dickey * .\" Copyright 1998-2014,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu.3x,v 1.45 2024/03/16 15:35:01 tom Exp $ -.TH menu 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: menu.3x,v 1.54 2025/11/12 01:27:41 tom Exp $ +.TH menu 3X 2025-11-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -47,7 +47,7 @@ .. .SH NAME \fBmenu\fP \- -curses extension for programming menus +present menus in \fIcurses\fP windows .SH SYNOPSIS .nf \fB#include <menu.h> @@ -70,7 +70,9 @@ To use the \fBmenu\fP library, link with the options The \fBmenu\fP library maintains a default value for item attributes. You can get or set this default by calling the appropriate \fBget_\fP or \fBset_\fP -routine with a \fBNULL\fP item pointer. +routine with a +.I NULL +item pointer. Changing this default with a \fBset_\fP function affects future item creations, but does not change the rendering of items already created. @@ -81,48 +83,48 @@ The following table lists each \fBmenu\fP routine and the name of the manual page on which it is described. .PP .TS -l l . +L L. \fBcurses\fP Routine Name Manual Page Name -= +_ current_item \fBmitem_current\fP(3X) -free_item \fBmitem_new\fP(3X) -free_menu \fBmenu_new\fP(3X) +free_item \fBmitem_new\fP(3X) +free_menu \fBmenu_new\fP(3X) item_count \fBmenu_items\fP(3X) item_description \fBmitem_name\fP(3X) item_index \fBmitem_current\fP(3X) -item_init \fBmenu_hook\fP(3X) -item_name \fBmitem_name\fP(3X) -item_opts \fBmitem_opts\fP(3X) +item_init \fBmenu_hook\fP(3X) +item_name \fBmitem_name\fP(3X) +item_opts \fBmitem_opts\fP(3X) item_opts_off \fBmitem_opts\fP(3X) item_opts_on \fBmitem_opts\fP(3X) -item_term \fBmenu_hook\fP(3X) +item_term \fBmenu_hook\fP(3X) item_userptr \fBmitem_userptr\fP(3X) item_value \fBmitem_value\fP(3X) item_visible \fBmitem_visible\fP(3X) -menu_back \fBmenu_attributes\fP(3X) +menu_back \fBmenu_attributes\fP(3X) menu_driver \fBmenu_driver\fP(3X) -menu_fore \fBmenu_attributes\fP(3X) +menu_fore \fBmenu_attributes\fP(3X) menu_format \fBmenu_format\fP(3X) -menu_grey \fBmenu_attributes\fP(3X) -menu_init \fBmenu_hook\fP(3X) +menu_grey \fBmenu_attributes\fP(3X) +menu_init \fBmenu_hook\fP(3X) menu_items \fBmenu_items\fP(3X) -menu_mark \fBmenu_mark\fP(3X) -menu_opts \fBmenu_opts\fP(3X) +menu_mark \fBmenu_mark\fP(3X) +menu_opts \fBmenu_opts\fP(3X) menu_opts_off \fBmenu_opts\fP(3X) menu_opts_on \fBmenu_opts\fP(3X) -menu_pad \fBmenu_attributes\fP(3X) +menu_pad \fBmenu_attributes\fP(3X) menu_pattern \fBmenu_pattern\fP(3X) menu_request_by_name \fBmenu_requestname\fP(3X) menu_request_name \fBmenu_requestname\fP(3X) menu_spacing \fBmenu_spacing\fP(3X) -menu_sub \fBmenu_win\fP(3X) -menu_term \fBmenu_hook\fP(3X) +menu_sub \fBmenu_win\fP(3X) +menu_term \fBmenu_hook\fP(3X) menu_userptr \fBmenu_userptr\fP(3X) -menu_win \fBmenu_win\fP(3X) -new_item \fBmitem_new\fP(3X) -new_menu \fBmenu_new\fP(3X) +menu_win \fBmenu_win\fP(3X) +new_item \fBmitem_new\fP(3X) +new_menu \fBmenu_new\fP(3X) pos_menu_cursor \fBmenu_cursor\fP(3X) -post_menu \fBmenu_post\fP(3X) +post_menu \fBmenu_post\fP(3X) scale_menu \fBmenu_win\fP(3X) set_current_item \fBmitem_current\fP(3X) set_item_init \fBmenu_hook\fP(3X) @@ -146,11 +148,13 @@ set_menu_term \fBmenu_hook\fP(3X) set_menu_userptr \fBmenu_userptr\fP(3X) set_menu_win \fBmenu_win\fP(3X) set_top_row \fBmitem_current\fP(3X) -top_row \fBmitem_current\fP(3X) +top_row \fBmitem_current\fP(3X) unpost_menu \fBmenu_post\fP(3X) .TE .SH RETURN VALUE -Routines that return pointers return \fBNULL\fP on error. +Routines that return pointers return +.I NULL +on error. Routines that return an integer return one of the following error codes: .TP 5 |