ncurses 5.7 - patch 20090725
[ncurses.git] / man / menu_format.3x
index 7dde28face88b021be0c846667d354144e07c600..f4d456f6f9600f4892b05887fd58c0975cc1741c 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998,2001 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1998-2001,2006 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,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_format.3x,v 1.8 2001/08/04 20:36:19 William.Setzer Exp $
+.\" $Id: menu_format.3x,v 1.10 2006/11/04 17:12:00 tom Exp $
 .TH menu_format 3X ""
 .SH NAME
 \fBmenu_format\fR - set and get menu sizes
@@ -43,28 +43,31 @@ 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