lib/libncurses/man/menu_format.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: menu_format.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
  31 .TH menu_format 3X ""
  32 .SH NAME
  33 \fBmenu_format\fR \- set and get menu sizes
  34 .SH SYNOPSIS
  35 \fB#include <menu.h>\fR
  36 .br
  37 int set_menu_format(MENU *menu, int rows, int cols);
  38 .br
  39 void menu_format(const MENU *menu, int *rows, int *cols);
  40 .br
  41 .SH DESCRIPTION
  42 The function \fBset_menu_format\fR sets the maximum display size of the given
  43 menu.  If this size is too small to display all menu items, the menu will be
  44 made scrollable. If this size is larger than the menus subwindow and the
  45 subwindow is too small to display all menu items, \fBpost_menu()\fR will fail.
  46 .PP
  47 The default format is 16 rows, 1 column.  Calling \fBset_menu_format\fR with a
  48 null menu pointer will change this default.  A zero row or column argument to
  49 \fBset_menu_format\fR is interpreted as a request not to change the current
  50 value.
  51 .PP
  52 The function \fBmenu_format\fR returns the maximum-size constraints for the
  53 given menu into the storage addressed by \fBrows\fR and \fBcols\fR.
  54 .SH RETURN VALUE
  55 These routines returns one of the following:
  56 .TP 5
  57 .B E_OK
  58 The routine succeeded.
  59 .TP 5
  60 .B E_SYSTEM_ERROR
  61 System error occurred (see \fBerrno\fR).
  62 .TP 5
  63 .B E_BAD_ARGUMENT
  64 Routine detected an incorrect or out-of-range argument.
  65 .TP 5
  66 .B E_POSTED
  67 The menu is already posted.
  68 .TP 5
  69 .B E_NOT_CONNECTED
  70 No items are connected to the menu.
  71 .SH SEE ALSO
  72 \fBcurses\fR(3X), \fBmenu\fR(3X).
  73 .SH NOTES
  74 The header file \fB<menu.h>\fR automatically includes the header file
  75 \fB<curses.h>\fR.
  76 .SH PORTABILITY
  77 These routines emulate the System V menu library.  They were not supported on
  78 Version 7 or BSD versions.
  79 .SH AUTHORS
  80 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  81 S. Raymond.