X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fmenu_format.3x;h=7abe94e664a295964a030dca745c48b6efbd9f7e;hb=6662c1ccb49cb09d0f2cec2ec6150410a0fd0f7f;hp=ca2e8ef5a0ecfc53efa1c09439e202336f70b17f;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/menu_format.3x b/man/menu_format.3x index ca2e8ef5..7abe94e6 100644 --- a/man/menu_format.3x +++ b/man/menu_format.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 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 +28,35 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_format.3x,v 1.17 2020/02/02 23:34:34 tom Exp $ +.\" $Id: menu_format.3x,v 1.21 2022/02/12 20:05:11 tom Exp $ .TH menu_format 3X "" .SH NAME \fBset_menu_format\fP, \fBmenu_format\fP \- set and get menu sizes .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_menu_format(MENU *\fImenu\fB, int \fIrows\fB, int \fIcols\fB);\fR .br -int set_menu_format(MENU *menu, int rows, int cols); -.br -void menu_format(const MENU *menu, int *rows, int *cols); +\fBvoid menu_format(const MENU *\fImenu\fB, int *\fIrows\fB, int *\fIcols\fB);\fR .br .SH DESCRIPTION -The function \fBset_menu_format\fR sets the maximum display size of the given +The function \fBset_menu_format\fP sets the maximum display size of the given menu. If this size is too small to display all menu items, the menu will be made scrollable. If this size is larger than the menus subwindow and the -subwindow is too small to display all menu items, \fBpost_menu\fR will fail. +subwindow is too small to display all menu items, \fBpost_menu\fP will fail. .PP The default format is 16 rows, 1 column. -Calling \fBset_menu_format\fR with a +Calling \fBset_menu_format\fP with a null menu pointer will change this default. A zero row or column argument to -\fBset_menu_format\fR is interpreted as a request not to change the current +\fBset_menu_format\fP is interpreted as a request not to change the current value. .PP -The function \fBmenu_format\fR returns the maximum-size constraints for the -given menu into the storage addressed by \fBrows\fR and \fBcols\fR. +The function \fBmenu_format\fP returns the maximum-size constraints for the +given menu into the storage addressed by \fBrows\fP and \fBcols\fP. .SH RETURN VALUE These routines returns one of the following: .TP 5 @@ -64,7 +64,7 @@ These routines returns one of the following: 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_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -75,10 +75,10 @@ The menu is already posted. .B E_NOT_CONNECTED No items are connected to the menu. .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