Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/lib/libmenu Cleanup; improve formatting and descriptions; an...
details: https://anonhg.NetBSD.org/src/rev/e06dbb42f57c
branches: trunk
changeset: 509215:e06dbb42f57c
user: wiz <wiz%NetBSD.org@localhost>
date: Sun Apr 29 19:07:06 2001 +0000
description:
Cleanup; improve formatting and descriptions; and some minor fixes here
and there.
diffstat:
lib/libmenu/menu_attributes.3 | 69 +++++----
lib/libmenu/menu_cursor.3 | 65 +++++----
lib/libmenu/menu_driver.3 | 141 +++++++++---------
lib/libmenu/menu_format.3 | 36 ++--
lib/libmenu/menu_hook.3 | 20 +-
lib/libmenu/menu_item_current.3 | 39 ++--
lib/libmenu/menu_item_name.3 | 16 +-
lib/libmenu/menu_item_new.3 | 41 ++--
lib/libmenu/menu_item_opts.3 | 36 ++--
lib/libmenu/menu_item_userptr.3 | 28 +--
lib/libmenu/menu_item_value.3 | 31 ++--
lib/libmenu/menu_item_visible.3 | 30 +--
lib/libmenu/menu_items.3 | 35 ++--
lib/libmenu/menu_mark.3 | 67 +++++----
lib/libmenu/menu_new.3 | 37 ++--
lib/libmenu/menu_opts.3 | 38 ++--
lib/libmenu/menu_pattern.3 | 35 ++--
lib/libmenu/menu_post.3 | 64 +++++---
lib/libmenu/menu_userptr.3 | 28 +--
lib/libmenu/menu_win.3 | 72 +++++----
lib/libmenu/menus.3 | 288 +++++++++++++++++++++++++--------------
21 files changed, 664 insertions(+), 552 deletions(-)
diffs (truncated from 1981 to 300 lines):
diff -r f84fc1029590 -r e06dbb42f57c lib/libmenu/menu_attributes.3
--- a/lib/libmenu/menu_attributes.3 Sun Apr 29 18:08:11 2001 +0000
+++ b/lib/libmenu/menu_attributes.3 Sun Apr 29 19:07:06 2001 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: menu_attributes.3,v 1.3 2001/02/26 01:26:05 blymn Exp $
+.\" $NetBSD: menu_attributes.3,v 1.4 2001/04/29 19:07:06 wiz Exp $
.\"
.\" Copyright (c) 1999
.\" Brett Lymn - blymn%baea.com.au@localhost, brett_lymn%yahoo.com.au@localhost
@@ -29,9 +29,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September, 1999
+.Dd September 10, 1999
.Dt MENU_ATTRIBUTES 3
-.Os BSD 4
+.Os
.Sh NAME
.Nm menu_back ,
.Nm menu_fore ,
@@ -41,7 +41,7 @@
.Nm set_menu_fore ,
.Nm set_menu_grey ,
.Nm set_menu_pad
-.Nd menu library
+.Nd get and set menu attributes
.Sh LIBRARY
.Lb libmenu
.Sh SYNOPSIS
@@ -66,13 +66,13 @@
The
.Fn menu_back
function returns the value of the background attribute for the menu
-passed. This attribute is set by the
+passed. This attribute is set by the
.Fn set_menu_back
call.
The
.Fn menu_fore
function returns the value of the foreground character attribute for
-the menu passed. This attribute is set by the
+the menu passed. This attribute is set by the
.Fn set_menu_fore
function.
The
@@ -91,36 +91,43 @@
.Sh RETURN VALUES
The functions return one of the following error values:
.Pp
-.ta 20
-.nf
-E_OK The function was successful
-E_SYSTEM_ERROR There was a system error during the call.
-E_BAD_ARGUMENT One or more of the arguments passed to the function
- was incorrect.
-E_POSTED The menu is already posted.
-E_CONNECTED An item was already connected to a menu.
-E_BAD_STATE The function was called from within an initialisation
- or termination routine.
-E_NO_ROOM The menu does not fit within the subwindow.
-E_NOT_POSTED The menu is not posted
-E_UNKNOWN_COMMAND The menu driver does not recognise the request
- passed to it.
-E_NO_MATCH The character search failed to find a match.
-E_NOT_SELECTABLE The item could not be selected.
-E_NOT_CONNECTED The item is not connected to a menu.
-E_REQUEST_DENIED The menu driver could not process the request.
-.fi
-.ft 1
-.br
-.ne 8
+.Bl -tag -width E_UNKNOWN_COMMAND -compact
+.It Er E_OK
+The function was successful.
+.It Er E_SYSTEM_ERROR
+There was a system error during the call.
+.It Er E_BAD_ARGUMENT
+One or more of the arguments passed to the function was incorrect.
+.It Er E_POSTED
+The menu is already posted.
+.It Er E_CONNECTED
+An item was already connected to a menu.
+.It Er E_BAD_STATE
+The function was called from within an initialisation or termination
+routine.
+.It Er E_NO_ROOM
+The menu does not fit within the subwindow.
+.It Er E_NOT_POSTED
+The menu is not posted.
+.It Er E_UNKNOWN_COMMAND
+The menu driver does not recognise the request passed to it.
+.It Er E_NO_MATCH
+The character search failed to find a match.
+.It Er E_NOT_SELECTABLE
+The item could not be selected.
+.It Er E_NOT_CONNECTED
+The item is not connected to a menu.
+.It Er E_REQUEST_DENIED
+The menu driver could not process the request.
+.El
.Sh SEE ALSO
.Xr curses 3 ,
.Xr menus 3
.Sh NOTES
The header
-.Xr <menu.h>
+.Pa <menu.h>
automatically includes both
-.Xr <curses.h>
+.Pa <curses.h>
and
-.Xr <eti.h>
+.Pa <eti.h> .
diff -r f84fc1029590 -r e06dbb42f57c lib/libmenu/menu_cursor.3
--- a/lib/libmenu/menu_cursor.3 Sun Apr 29 18:08:11 2001 +0000
+++ b/lib/libmenu/menu_cursor.3 Sun Apr 29 19:07:06 2001 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: menu_cursor.3,v 1.3 2001/02/26 01:26:05 blymn Exp $
+.\" $NetBSD: menu_cursor.3,v 1.4 2001/04/29 19:07:06 wiz Exp $
.\"
.\" Copyright (c) 1999
.\" Brett Lymn - blymn%baea.com.au@localhost, brett_lymn%yahoo.com.au@localhost
@@ -29,12 +29,12 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September, 1999
+.Dd September 10, 1999
.Dt MENU_CURSOR 3
-.Os BSD 4
+.Os
.Sh NAME
.Nm pos_menu_cursor
-.Nd menu library
+.Nd position cursor in menu window
.Sh LIBRARY
.Lb libmenu
.Sh SYNOPSIS
@@ -50,36 +50,43 @@
.Sh RETURN VALUES
The functions return one of the following error values:
.Pp
-.ta 20
-.nf
-E_OK The function was successful
-E_SYSTEM_ERROR There was a system error during the call.
-E_BAD_ARGUMENT One or more of the arguments passed to the function
- was incorrect.
-E_POSTED The menu is already posted.
-E_CONNECTED An item was already connected to a menu.
-E_BAD_STATE The function was called from within an initialisation
- or termination routine.
-E_NO_ROOM The menu does not fit within the subwindow.
-E_NOT_POSTED The menu is not posted
-E_UNKNOWN_COMMAND The menu driver does not recognise the request
- passed to it.
-E_NO_MATCH The character search failed to find a match.
-E_NOT_SELECTABLE The item could not be selected.
-E_NOT_CONNECTED The item is not connected to a menu.
-E_REQUEST_DENIED The menu driver could not process the request.
-.fi
-.ft 1
-.br
-.ne 8
+.Bl -tag -width E_UNKNOWN_COMMAND -compact
+.It Er E_OK
+The function was successful.
+.It Er E_SYSTEM_ERROR
+There was a system error during the call.
+.It Er E_BAD_ARGUMENT
+One or more of the arguments passed to the function was incorrect.
+.It Er E_POSTED
+The menu is already posted.
+.It Er E_CONNECTED
+An item was already connected to a menu.
+.It Er E_BAD_STATE
+The function was called from within an initialisation or termination
+routine.
+.It Er E_NO_ROOM
+The menu does not fit within the subwindow.
+.It Er E_NOT_POSTED
+The menu is not posted.
+.It Er E_UNKNOWN_COMMAND
+The menu driver does not recognise the request passed to it.
+.It Er E_NO_MATCH
+The character search failed to find a match.
+.It Er E_NOT_SELECTABLE
+The item could not be selected.
+.It Er E_NOT_CONNECTED
+The item is not connected to a menu.
+.It Er E_REQUEST_DENIED
+The menu driver could not process the request.
+.El
.Sh SEE ALSO
.Xr curses 3 ,
.Xr menus 3
.Sh NOTES
The header
-.Xr <menu.h>
+.Pa <menu.h>
automatically includes both
-.Xr <curses.h>
+.Pa <curses.h>
and
-.Xr <eti.h>
+.Pa <eti.h> .
diff -r f84fc1029590 -r e06dbb42f57c lib/libmenu/menu_driver.3
--- a/lib/libmenu/menu_driver.3 Sun Apr 29 18:08:11 2001 +0000
+++ b/lib/libmenu/menu_driver.3 Sun Apr 29 19:07:06 2001 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: menu_driver.3,v 1.3 2001/02/26 01:26:05 blymn Exp $
+.\" $NetBSD: menu_driver.3,v 1.4 2001/04/29 19:07:06 wiz Exp $
.\"
.\" Copyright (c) 1999
.\" Brett Lymn - blymn%baea.com.au@localhost, brett_lymn%yahoo.com.au@localhost
@@ -29,12 +29,12 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September, 1999
+.Dd September 10, 1999
.Dt MENU_DRIVER 3
-.Os BSD 4
+.Os
.Sh NAME
.Nm menu_driver
-.Nd menu library
+.Nd main menu handling function
.Sh LIBRARY
.Lb libmenu
.Sh SYNOPSIS
@@ -48,54 +48,54 @@
by c parameter and performs the requested action on the menu given.
The following commands may be given to the menu driver:
.Pp
-.ta 20
-.nf
-Command Action
-.Pp
-REQ_LEFT_ITEM Sets the new current item to be the item to
- the left of the current item.
-REQ_RIGHT_ITEM Sets the new current item to be the item to
- the rights of the current item.
-REQ_UP_ITEM Sets the new current item to be the item above
- the current item.
-REQ_DOWN_ITEM Sets the new current item to be the item below
- the current item.
-REQ_SCR_ULINE Scroll the menu one line towards the bottom of
- the menu window. The new current item becomes the
- item immediately above the current item.
-REQ_SCR_DLINE Scroll the menu one line towards the top of
- the menu window. The new current item becomes
- the item immediately below the current item.
-REQ_SCR_DPAGE Scroll the menu one page towards the bottom of
- the menu window.
-REQ_SCR_UPAGE Scroll the menu one page towards the top of
- the menu window.
-REQ_FIRST_ITEM Set the current item to be the first item in
- the menu.
-REQ_LAST_ITEM Set the current item to be the last item in
- the menu.
-REQ_NEXT_ITEM Set the new current item to be the next item
- in the item array after the current item.
-REQ_PREV_ITEM Set the new current item to be the item before
- the current item in the items array.
-REQ_TOGGLE_ITEM If the item is selectable then toggle the
- item's value.
-REQ_CLEAR_PATTERN Clear all the characters currently in the
- menu's pattern buffer.
-REQ_BACK_PATTERN Remove the last character from the pattern
- buffer.
-REQ_NEXT_MATCH Attempt to find the next item that matches the
- pattern buffer.
-REQ_PREV_MATCH Attempt to find the previous item that matches
- the pattern buffer.
-.fi
-.ft 1
-.br
-.ne 8
-If
+.Bl -tag -width REQ_CLEAR_PATTERN -compact
+.It Command
+Action
+.It REQ_LEFT_ITEM
+Sets the new current item to be the item to the left of the current
+item.
+.It REQ_RIGHT_ITEM
+Sets the new current item to be the item to the rights of the current
+item.
+.It REQ_UP_ITEM
+Sets the new current item to be the item above the current item.
+.It REQ_DOWN_ITEM
+Sets the new current item to be the item below the current item.
+.It REQ_SCR_ULINE
+Scroll the menu one line towards the bottom of the menu window. The
+new current item becomes the item immediately above the current item.
+.It REQ_SCR_DLINE
Home |
Main Index |
Thread Index |
Old Index