usr/src/man/man3curses/menu_items.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH MENU_ITEMS 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_items, set_menu_items, item_count \- connect and disconnect items to and
  10 from menus
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  15 #include <menu.h>
  16
  17 \fBint\fR \fBset_menu_items\fR(\fBMENU *\fR\fImenu\fR, \fBITEM **\fR\fIitems\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBITEM **\fR\fBmenu_items\fR(\fBMENU *\fR\fImenu\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBitem_count\fR(\fBMENU *\fR\fImenu\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 \fBset_menu_items()\fR changes the item pointer array connected to \fImenu\fR
  34 to the item pointer array \fIitems\fR.\fBmenu_items()\fR returns a pointer to
  35 the item pointer array connected to \fImenu\fR.\fBitem_count()\fR returns the
  36 number of items in \fImenu\fR.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 \fBmenu_items()\fR returns \fBNULL\fR on error.
  41 .sp
  42 .LP
  43 \fBitem_count()\fR returns -1 on error.
  44 .sp
  45 .LP
  46 \fBset_menu_items()\fR returns one of the following:
  47 .sp
  48 .ne 2
  49 .na
  50 \fBE_OK\fR
  51 .ad
  52 .RS 18n
  53 The routine returned successfully.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fBE_SYSTEM_ERROR\fR
  60 .ad
  61 .RS 18n
  62 System error.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fBE_BAD_ARGUMENT\fR
  69 .ad
  70 .RS 18n
  71 An incorrect argument was passed to the routine.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fBE_POSTED\fR
  78 .ad
  79 .RS 18n
  80 The menu is already posted.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fBE_CONNECTED\fR
  87 .ad
  88 .RS 18n
  89 One or more items are already connected to another menu.
  90 .RE
  91
  92 .SH ATTRIBUTES
  93 .sp
  94 .LP
  95 See \fBattributes\fR(5) for descriptions of the following attributes:
  96 .sp
  97
  98 .sp
  99 .TS
 100 box;
 101 c | c
 102 l | l .
 103 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 104 _
 105 MT-Level        Unsafe
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
 112 .SH NOTES
 113 .sp
 114 .LP
 115 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 116 \fB<curses.h>\fR\&.