usr/src/man/man3curses/menu_mark.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_MARK 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_mark, set_menu_mark \- menus mark string routines
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <menu.h>
  15
  16 \fBint\fR \fBset_menu_mark\fR(\fBMENU *\fR\fImenu\fR, \fBchar *\fR\fImark\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBchar *\fR\fBmenu_mark\fR(\fBMENU *\fR\fImenu\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 \fBmenus\fR displays mark strings to distinguish selected items in a menu (or
  28 the current item in a single-valued menu). \fBset_menu_mark()\fR sets the mark
  29 string of \fImenu\fR to \fImark\fR. \fBmenu_mark()\fR returns a pointer to the
  30 mark string of \fImenu\fR.
  31 .SH RETURN VALUES
  32 .sp
  33 .LP
  34 \fBmenu_mark()\fR returns \fBNULL\fR on error. \fBset_menu_mark()\fR returns
  35 one of the following:
  36 .sp
  37 .ne 2
  38 .na
  39 \fBE_OK\fR
  40 .ad
  41 .RS 19n
  42 The routine returned successfully.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fBE_SYSTEM_ERROR\fR
  49 .ad
  50 .RS 19n
  51 System error.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fBE_BAD_ARGUMENT\fR
  58 .ad
  59 .RS 19n
  60 An incorrect argument was passed to the routine.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 MT-Level        Unsafe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
  83 .SH NOTES
  84 .sp
  85 .LP
  86 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  87 \fB<curses.h>\fR\&.