lib/libncurses/man/menu.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998,2000,2002 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.3x,v 1.15 2002/01/19 22:48:58 tom Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/menu.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH menu 3X ""
  33 .SH NAME
  34 \fBmenu\fR - curses extension for programming menus
  35 .SH SYNOPSIS
  36 \fB#include <menu.h>\fR
  37 .br
  38 .SH DESCRIPTION
  39 The \fBmenu\fR library provides terminal-independent facilities for composing
  40 menu systems on character-cell terminals.  The library includes: item routines,
  41 which create and modify menu items; and menu routines, which group items into
  42 menus, display menus on the screen, and handle interaction with the user.
  43
  44 The \fBmenu\fR library uses the \fBcurses\fR libraries, and a curses
  45 initialization routine such as \fBinitscr\fR must be called before using any of
  46 these functions.  To use the \fBmenu\fR library, link with the options
  47 \fB-lmenu -lcurses\fR.
  48
  49 .SS Current Default Values for Item Attributes
  50
  51 The \fBmenu\fR library maintains a default value for item attributes.  You can
  52 get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR
  53 routine with a \fBNULL\fR item pointer.  Changing this default with a
  54 \fBset_\fR function affects future item creations, but does not change the
  55 rendering of items already created.
  56
  57 .SS Routine Name Index
  58
  59 The following table lists each \fBmenu\fR routine and the name of
  60 the manual page on which it is described.
  61
  62 .TS
  63 l l .
  64 \fBcurses\fR Routine Name       Manual Page Name
  65 =
  66 current_item    \fBmitem_current\fR(3X)
  67 free_item       \fBmitem_new\fR(3X)
  68 free_menu       \fBmenu_new\fR(3X)
  69 item_count      \fBmenu_items\fR(3X)
  70 item_description        \fBmitem_name\fR(3X)
  71 item_index      \fBmitem_current\fR(3X)
  72 item_init       \fBmenu_hook\fR(3X)
  73 item_name       \fBmitem_name\fR(3X)
  74 item_opts       \fBmitem_opts\fR(3X)
  75 item_opts_off   \fBmitem_opts\fR(3X)
  76 item_opts_on    \fBmitem_opts\fR(3X)
  77 item_term       \fBmenu_hook\fR(3X)
  78 item_userptr    \fBmitem_userptr\fR(3X)
  79 item_value      \fBmitem_value\fR(3X)
  80 item_visible    \fBmitem_visible\fR(3X)
  81 menu_back       \fBmenu_attributes\fR(3X)
  82 menu_driver     \fBmenu_driver\fR(3X)
  83 menu_fore       \fBmenu_attributes\fR(3X)
  84 menu_format     \fBmenu_format\fR(3X)
  85 menu_grey       \fBmenu_attributes\fR(3X)
  86 menu_init       \fBmenu_hook\fR(3X)
  87 menu_items      \fBmenu_items\fR(3X)
  88 menu_mark       \fBmenu_mark\fR(3X)
  89 menu_opts       \fBmenu_opts\fR(3X)
  90 menu_opts_off   \fBmenu_opts\fR(3X)
  91 menu_opts_on    \fBmenu_opts\fR(3X)
  92 menu_pad        \fBmenu_attributes\fR(3X)
  93 menu_pattern    \fBmenu_pattern\fR(3X)
  94 menu_request_by_name    \fBmenu_requestname\fR(3X)
  95 menu_request_name       \fBmenu_requestname\fR(3X)
  96 menu_spacing    \fBmenu_spacing\fR(3X)
  97 menu_sub        \fBmenu_win\fR(3X)
  98 menu_term       \fBmenu_hook\fR(3X)
  99 menu_userptr    \fBmenu_userptr\fR(3X)
 100 menu_win        \fBmenu_win\fR(3X)
 101 new_item        \fBmitem_new\fR(3X)
 102 new_menu        \fBmenu_new\fR(3X)
 103 pos_menu_cursor \fBmenu_cursor\fR(3X)
 104 post_menu       \fBmenu_post\fR(3X)
 105 scale_menu      \fBmenu_win\fR(3X)
 106 set_current_item        \fBmitem_current\fR(3X)
 107 set_item_init   \fBmenu_hook\fR(3X)
 108 set_item_opts   \fBmitem_opts\fR(3X)
 109 set_item_term   \fBmenu_hook\fR(3X)
 110 set_item_userptr        \fBmitem_userptr\fR(3X)
 111 set_item_value  \fBmitem_value\fR(3X)
 112 set_menu_back   \fBmenu_attributes\fR(3X)
 113 set_menu_fore   \fBmenu_attributes\fR(3X)
 114 set_menu_format \fBmenu_format\fR(3X)
 115 set_menu_grey   \fBmenu_attributes\fR(3X)
 116 set_menu_init   \fBmenu_hook\fR(3X)
 117 set_menu_items  \fBmenu_items\fR(3X)
 118 set_menu_mark   \fBmenu_mark\fR(3X)
 119 set_menu_opts   \fBmitem_opts\fR(3X)
 120 set_menu_pad    \fBmenu_attributes\fR(3X)
 121 set_menu_pattern        \fBmenu_pattern\fR(3X)
 122 set_menu_spacing        \fBmenu_spacing\fR(3X)
 123 set_menu_sub    \fBmenu_win\fR(3X)
 124 set_menu_term   \fBmenu_hook\fR(3X)
 125 set_menu_userptr        \fBmenu_userptr\fR(3X)
 126 set_menu_win    \fBmenu_win\fR(3X)
 127 set_top_row     \fBmitem_current\fR(3X)
 128 top_row         \fBmitem_current\fR(3X)
 129 unpost_menu     \fBmenu_post\fR(3X)
 130 .TE
 131 .SH RETURN VALUE
 132 Routines that return pointers return \fBNULL\fR on error.  Routines that return
 133 an integer return one of the following error codes:
 134 .TP 5
 135 \fBE_OK\fR
 136 The routine succeeded.
 137 .TP 5
 138 \fBE_SYSTEM_ERROR\fR
 139 System error occurred (see \fBerrno\fR).
 140 .TP 5
 141 \fBE_BAD_ARGUMENT\fR
 142 Routine detected an incorrect or out-of-range argument.
 143 .TP 5
 144 \fBE_POSTED\fR
 145 The menu is already posted.
 146 .TP 5
 147 \fBE_BAD_STATE\fR
 148 Routine was called from an initialization or termination function.
 149 .TP 5
 150 \fBE_NO_ROOM\fR
 151 Menu is too large for its window.
 152 .TP 5
 153 \fBE_NOT_POSTED\fR
 154 The menu has not been posted.
 155 .TP 5
 156 \fBE_UNKNOWN_COMMAND\fR
 157 The menu driver code saw an unknown request code.
 158 .TP 5
 159 \fBE_NO_MATCH\fR
 160 Character failed to match.
 161 .TP 5
 162 \fBE_NOT_SELECTABLE\fR
 163 The designated item cannot be selected.
 164 .TP 5
 165 \fBE_NOT_CONNECTED\fR
 166 No items are connected to the menu.
 167 .TP 5
 168 \fBE_REQUEST_DENIED\fR
 169 The menu driver could not process the request.
 170 .SH SEE ALSO
 171 \fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed
 172 descriptions of the entry points.
 173 .SH NOTES
 174 The header file \fB<menu.h>\fR automatically includes the header files
 175 \fB<curses.h>\fR and \fB<eti.h>\fR.
 176
 177 In your library list, libmenu.a should be before libncurses.a; that is,
 178 you want to say `-lmenu -lncurses', not the other way around (which would
 179 give you a link error using GNU \fBld\fR(1) and many other linkers).
 180 .SH PORTABILITY
 181 These routines emulate the System V menu library.  They were not supported on
 182 Version 7 or BSD versions.
 183 .SH AUTHORS
 184 Juergen Pfeifer.  Manual pages and adaptation for ncurses by Eric
 185 S. Raymond.
 186 .\"#
 187 .\"# The following sets edit modes for GNU EMACS
 188 .\"# Local Variables:
 189 .\"# mode:nroff
 190 .\"# fill-column:79
 191 .\"# End: