X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_format.3x;h=b9a572b017741941ffb9db7474f43fc3e9421e55;hp=57c77a390ede3989404e728d77e7e8ed9aeae814;hb=21c8ffa0edf2e389f3f674f0c08009002c6f357d;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;ds=sidebyside diff --git a/man/menu_format.3x b/man/menu_format.3x index 57c77a39..b9a572b0 100644 --- a/man/menu_format.3x +++ b/man/menu_format.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,44 +27,47 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_format.3x,v 1.7 1998/11/29 01:09:39 Rick.Ohnemus Exp $ +.\" $Id: menu_format.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH menu_format 3X "" .SH NAME -\fBmenu_format\fR - set and get menu sizes +\fBmenu_format\fR \- 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 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 @@ -76,9 +79,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: