ncurses 6.0 - patch 20161015
[ncurses.git] / man / menu_format.3x
index 57c77a390ede3989404e728d77e7e8ed9aeae814..b72fe22e2c346c2378f64a03132796b689c23215 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_format.3x,v 1.7 1998/11/29 01:09:39 Rick.Ohnemus Exp $
+.\" $Id: menu_format.3x,v 1.14 2016/10/15 17:02:31 tom Exp $
 .TH menu_format 3X ""
 .SH NAME
 .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 <menu.h>\fR
 .br
 int set_menu_format(MENU *menu, int rows, int cols);
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\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
 .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.
-
+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.
 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
 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
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fR).
 .TP 5
 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
 Routine detected an incorrect or out-of-range argument.
 .TP 5
-\fBE_POSTED\fR
+.B E_POSTED
 The menu is already 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
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 .SH NOTES
@@ -76,9 +80,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .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: