lib/libmenu/menu_format.3

   1 .\"     $NetBSD: menu_format.3,v 1.8 2002/10/01 19:26:59 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999
   4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
   5 .\"
   6 .\" This code is donated to The NetBSD Foundation by the author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd September 10, 1999
  33 .Dt MENU_FORMAT 3
  34 .Os
  35 .Sh NAME
  36 .Nm menu_format ,
  37 .Nm set_menu_format
  38 .Nd get or set number of rows and columns of items
  39 .Sh LIBRARY
  40 .Lb libmenu
  41 .Sh SYNOPSIS
  42 .In menu.h
  43 .Ft void
  44 .Fn menu_format "MENU *menu" "int *rows" "int *cols"
  45 .Ft int
  46 .Fn set_menu_format "MENU *menu" "int rows" "int cols"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn menu_format
  50 returns the number of rows and columns of items that can be displayed
  51 by the menu.
  52 The format is set by the
  53 .Fn set_menu_format
  54 function call.
  55 Note that the rows and columns defined here are not the size of the
  56 window but rather the number of rows and columns of items.
  57 .Sh RETURN VALUES
  58 The functions return one of the following error values:
  59 .Pp
  60 .Bl -tag -width E_BAD_ARGUMENT -compact
  61 .It Er E_OK
  62 The function was successful.
  63 .It Er E_BAD_ARGUMENT
  64 One or more of the arguments passed to the function was incorrect.
  65 .It Er E_POSTED
  66 The menu is already posted.
  67 .El
  68 .Sh SEE ALSO
  69 .Xr curses 3 ,
  70 .Xr menus 3
  71 .Sh NOTES
  72 The header
  73 .Pa \*[Lt]menu.h\*[Gt]
  74 automatically includes both
  75 .Pa \*[Lt]curses.h\*[Gt]
  76 and
  77 .Pa \*[Lt]eti.h\*[Gt] .