X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_format.3x;h=c9efcd76c38e97ca62e3be5e5c51d9c212415513;hp=a901a065192c686a9ab714830860bd2a2e7c7689;hb=59c1a9740d123db3cecafe76e18f7848081a670b;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/menu_format.3x b/man/menu_format.3x index a901a065..c9efcd76 100644 --- a/man/menu_format.3x +++ b/man/menu_format.3x @@ -1,40 +1,74 @@ '\" t +.\"*************************************************************************** +.\" Copyright (c) 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: menu_format.3x,v 1.13 2015/12/05 23:01:16 tom Exp $ .TH menu_format 3X "" .SH NAME -\fBmenu_format\fR - set and get menu sizes +\fBset_menu_format\fP, +\fBmenu_format\fP \- set and get menu sizes .SH SYNOPSIS \fB#include \fR .br int set_menu_format(MENU *menu, int rows, int cols); .br -int menu_format(const MENU *menu, int *rows, int *cols); +void menu_format(const MENU *menu, int *rows, int *cols); .br .SH DESCRIPTION The function \fBset_menu_format\fR sets the maximum display size of the given -window. If this size is too small to display all menu items, the menu will be -made scrollable. - +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 \fBset_menu_format\fR 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. .SH RETURN VALUE These routines returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR +.B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_POSTED\fR +.B E_POSTED The menu is already posted. +.TP 5 +.B E_NOT_CONNECTED +No items are connected to the menu. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES @@ -46,9 +80,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: