usr/src/man/man3curses/menu_post.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_POST 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_post, post_menu, unpost_menu \- write or erase menus from associated
  10 subwindows
  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 \fBpost_menu\fR(\fBMENU *\fR\fImenu\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBunpost_menu\fR(\fBMENU *\fR\fImenu\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 \fBpost_menu()\fR writes \fImenu\fR to the subwindow. The application
  29 programmer must use \fBcurses\fR library routines to display the menu on the
  30 physical screen or call \fBupdate_panels()\fR if the \fBpanels\fR library is
  31 being used.
  32 .sp
  33 .LP
  34 \fBunpost_menu()\fR erases \fImenu\fR from its associated subwindow.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 These routines return one of the following:
  39 .sp
  40 .ne 2
  41 .na
  42 \fBE_OK\fR
  43 .ad
  44 .RS 19n
  45 The routine returned successfully.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fBE_SYSTEM_ERROR\fR
  52 .ad
  53 .RS 19n
  54 System error.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fBE_BAD_ARGUMENT\fR
  61 .ad
  62 .RS 19n
  63 An incorrect argument was passed to the routine.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fBE_POSTED\fR
  70 .ad
  71 .RS 19n
  72 The menu is already posted.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fBE_BAD_STATE\fR
  79 .ad
  80 .RS 19n
  81 The routine was called from an initialization or termination function.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fBE_NO_ROOM\fR
  88 .ad
  89 .RS 19n
  90 The menu does not fit within its subwindow.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fBE_NOT_POSTED\fR
  97 .ad
  98 .RS 19n
  99 The menu has not been posted.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fBE_NOT_CONNECTED\fR
 106 .ad
 107 .RS 19n
 108 No items are connected to the menu.
 109 .RE
 110
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 MT-Level        Unsafe
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBpanels\fR(3CURSES),
 131 \fBattributes\fR(5)
 132 .SH NOTES
 133 .sp
 134 .LP
 135 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 136 \fB<curses.h>\fR\&.