X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_format.3x;h=d01f27ea26f83ac21ff393b7b978820dbb0a4e46;hp=b72fe22e2c346c2378f64a03132796b689c23215;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=c3b21f65a2687f3894a0d3217006c23f162c893a diff --git a/man/menu_format.3x b/man/menu_format.3x index b72fe22e..d01f27ea 100644 --- a/man/menu_format.3x +++ b/man/menu_format.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2016 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2015,2016 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,26 +28,30 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_format.3x,v 1.14 2016/10/15 17:02:31 tom Exp $ +.\" $Id: menu_format.3x,v 1.18 2020/10/17 23:43: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 +.sp +\fBint set_menu_format(MENU *\fP\fImenu\fP\fB, int \fP\fIrows\fP\fB, int \fP\fIcols\fP\fB);\fP .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 *\fP\fImenu\fP\fB, int *\fP\fIrows\fP\fB, int *\fP\fIcols\fP\fB);\fP .br .SH DESCRIPTION The function \fBset_menu_format\fR 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 +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. .PP -The default format is 16 rows, 1 column. Calling \fBset_menu_format\fR with a -null menu pointer will change this default. A zero row or column argument to +The default format is 16 rows, 1 column. +Calling \fBset_menu_format\fR 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 value. .PP @@ -59,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). +System error occurred (see \fBerrno\fR(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -75,8 +80,9 @@ No items are connected to the menu. 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 +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.