← Back to branch summary

~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/menu_mark.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/menu_mark.3x
1
1
'\" t
2
2
.\"***************************************************************************
3
 
.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
 
3
.\" Copyright (c) 1998,2006 Free Software Foundation, Inc.                   *
4
4
.\"                                                                          *
5
5
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
6
6
.\" copy of this software and associated documentation files (the            *
27
27
.\" authorization.                                                           *
28
28
.\"***************************************************************************
29
29
.\"
30
 
.\" $Id: menu_mark.3x,v 1.6 1998/11/29 01:10:03 Rick.Ohnemus Exp $
 
30
.\" $Id: menu_mark.3x,v 1.9 2006/11/04 18:33:18 tom Exp $
31
31
.TH menu_mark 3X ""
32
32
.SH NAME
33
33
\fBmenu_mark\fR - get and set the menu mark string
42
42
In order to make menu selections visible on older terminals without
43
43
highlighting or color capability, the menu library marks selected items
44
44
in a menu with a prefix string.
45
 
 
 
45
.PP
46
46
The function \fBset_menu_mark\fR sets the mark string for the given menu.
47
47
Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string.
48
48
Note that changing the length of the mark string for a menu while the
49
49
menu is posted is likely to produce unhelpful behavior.
50
 
 
 
50
.PP
51
51
The default string is "-" (a dash). Calling \fBset_menu_mark\fR with
52
 
a \fBNULL\fR menu argument will change this default.
53
 
 
 
52
a non-\fBNULL\fR menu argument will change this default.
 
53
.PP
54
54
The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if
55
55
there is none).
56
56
.SH RETURN VALUE
57
 
The function \fBmenu_mark\fR returns \fBNULL\fR on error.  The function
58
 
\fBset_menu_mark\fR may return the following error codes:
 
57
The function \fBmenu_mark\fR returns a pointer (which may be \fBNULL\fR).
 
58
It does not set errno.
 
59
.PP
 
60
The function \fBset_menu_mark\fR may return the following error codes:
59
61
.TP 5
60
 
\fBE_OK\fR
 
62
.B E_OK
61
63
The routine succeeded.
62
64
.TP 5
63
 
\fBE_SYSTEM_ERROR\fR
 
65
.B E_BAD_ARGUMENT
 
66
Routine detected an incorrect or out-of-range argument.
 
67
.TP 5
 
68
.B E_SYSTEM_ERROR
64
69
System error occurred (see \fBerrno\fR).
65
 
.TP 5
66
 
\fBE_BAD_ARGUMENT\fR
67
 
Routine detected an incorrect or out-of-range argument.
68
70
.SH SEE ALSO
69
71
\fBcurses\fR(3X), \fBmenu\fR(3X).
70
72
.SH NOTES