Menus.mesa
Copyright Ó 1985, 1986, 1987, 1991 by Xerox Corporation. All rights reserved.
Edited by McGregor on September 1, 1982 4:19 pm
Last Edited by: Maxwell, December 17, 1982 9:58 am
Doug Wyatt, January 20, 1987 0:02:56 am PST
Willie-s, October 8, 1991 1:05 pm PDT
DIRECTORY
Process USING [Milliseconds],
Rope USING [ROPE],
ViewerClasses USING [ClickProc, Menu, MenuRec, MenuEntry, MenuEntryRec, MenuLine, MouseButton];
Menus are the "button-like" commands displayed across the top of a viewer.
Menus: CEDAR DEFINITIONS
= BEGIN
Menu: TYPE = ViewerClasses.Menu;
MenuRec: TYPE = ViewerClasses.MenuRec;
MenuEntry: TYPE = ViewerClasses.MenuEntry;
MenuEntryRec: TYPE = ViewerClasses.MenuEntryRec;
MenuLine: TYPE = ViewerClasses.MenuLine;
Creating menus
CreateMenu:
PROC [lines: MenuLine ¬ 1]
RETURNS [menu: Menu];
Create a new menu with some number of lines of entries
CopyMenu:
PROC [old: Menu]
RETURNS [new: Menu];
Copy a menu and all of its entries
Menu notifications
MouseButton:
TYPE = ViewerClasses.MouseButton;
ClickProc:
TYPE = ViewerClasses.ClickProc;
For menus, parent is the parent Viewer; mouseButton indicates how the user invoked the button or menu; shift and control indicate the state of the shift and control keys when the menu was invoked.
MenuProc:
TYPE = ClickProc;
A synonym, for compatibility.
Operations on MenuEntries
CreateEntry:
PROC [name: Rope.
ROPE, proc: ClickProc, clientData:
REF
ANY ¬
NIL,
documentation:
REF
ANY ¬
NIL, fork:
BOOL ¬
TRUE, guarded:
BOOL ¬
FALSE
]
RETURNS [entry: MenuEntry];
Create an item that can be added to a menu. 'name' is the text that will be displayed to the user, 'proc' is the procedure that will get called when the user invokes the menu, 'clientData' is arbitray data that will be passed to the proc, 'documentation' may either be a Rope.ROPE or a ClickProc and will either be displayed in the message window or called respectively when a guarded entry has its cover removed. 'fork' will FORK and Detach a separate process when the proc is called, 'guarded' menu items have a diagonal cross-hatch pattern over the text that is removed when the user clicks at the menu item. Only if the user clicks at a guarded menu item while the 'cover' is off will the proc be called.
CopyEntry:
PROC [oldEntry: MenuEntry]
RETURNS [newEntry: MenuEntry];
SetGuarded:
PROC [entry: MenuEntry, guard:
BOOL];
SetClientData:
PROC [entry: MenuEntry, newData:
REF
ANY]
RETURNS [oldData:
REF
ANY];
SetDocumentation:
PROC [entry: MenuEntry, newDoc:
REF
ANY]
RETURNS [oldDoc:
REF
ANY];
Operations on Menus
FindEntry:
PROC [menu: Menu, entryName: Rope.
ROPE]
RETURNS [entry: MenuEntry];
Search for an entry given the name. Will return NIL if target name not found.
AppendMenuEntry:
PROC [menu: Menu, entry: MenuEntry, line: MenuLine ¬ 0];
Add a new menu entry to the end of a line
InsertMenuEntry:
PROC [menu: Menu, entry: MenuEntry, line: MenuLine ¬ 0];
Add a new menu entry to the front of a line
ReplaceMenuEntry:
PROC [menu: Menu, oldEntry: MenuEntry, newEntry: MenuEntry ¬
NIL];
Change an existing entry in a menu. If newEntry is NIL then the oldEntry will be deleted.
Will raise targetNotFound if target entry not found.
Append, insert, and replace MenuEntry's to/in linked lists of MenuEntry's.
MenuFromMenuEntry:
PUBLIC
PROC [entryList: MenuEntry]
RETURNS [Menu];
Returns a Menu with line 0 begin the given entryList.
MenuEntryFind:
PUBLIC
PROC[entryName: Rope.
ROPE, entryList: MenuEntry]
RETURNS [MenuEntry];
Search for an entry given the name. Will return NIL if target name not found.
MenuEntryAppend:
PUBLIC
PROC[entry: MenuEntry, entryList: MenuEntry]
RETURNS [MenuEntry];
Add the entry to the end of the list.
MenuEntryInsert:
PUBLIC
PROC[entry: MenuEntry, entryList: MenuEntry]
RETURNS [MenuEntry];
Add the entry to the beginning of the list.
MenuEntryReplace:
PUBLIC
PROC[entryList: MenuEntry, old: MenuEntry, new: MenuEntry]
RETURNS [MenuEntry];
Change an existing entry in a menu. If new is NIL then old will be deleted.
Will raise targetNotFound if target entry not found.
ChangeNumberOfLines:
PROC [menu: Menu, newLines: MenuLine];
GetNumberOfLines:
PROC [menu: Menu]
RETURNS [lines: MenuLine];
SetLine:
PROC [menu: Menu, line: MenuLine, entryList: MenuEntry];
GetLine:
PROC [menu: Menu, line: MenuLine]
RETURNS [entryList: MenuEntry];
armingTime: Process.Milliseconds = 100; -- cover removal time.
armedTime: Process.Milliseconds = 5000; -- unguarded interval.
END.