User Menu Help

Name:	User Menu
Version:	1.1
Last update:	2019-02-18 17:51:37

The User Menu for Alpha is a menu designed to store your personal Tcl procs and let them be executed from this menu.

Activation

To activate the User menu, go to Alpha ↣ Global Setup ↣ Menus and select the User Menu checkbox. Once it is installed and activated, you have a new menu represented by an icon showing an open document and a user's head. The bottom part of the menu always contains the following four items: New item..., Edit Item…, Delete Item… and Clear Menu.

Quick start

If you choose New Item…, a dialog window asks the name of the item you want to add to the menu and the name of the procedure that will be triggered when you select this item.
For instance, suppose you have defined a proc called convert::HexNum to convert hexadecimal numbers and you want to have a menu item called Convert Hex Numbers in the User Menu: all you have to do is to enter Convert Hex Numbers in the first field of the dialog and convert::HexNum in the second field.
You must make sure that the convert::HexNum proc is found by the Tcl interpreter. You can for instance store the proc's definition in the prefs.tcl preferences file which is automatically sourced each time Alpha is launched.

Menu Items Description

Here is the explanation of all the fixed menu items displayed at the bottom of the User Menu.

New Item…: This command displays a dialog window in which you specify the name of the item you want to insert in the User menu and the name of the proc associated with this item: it is the proc which will be invoked when the item is selected in the menu. There is a Menu Shortcut field which lets you associate a key combination to the menu item: use the arrow button to specify the key combo.
Edit Item…: This command brings up a list dialog to select the item you want to edit and then displays a window similar to the New Item window. Modify the settings there and save them by pressing the OK button.
Delete Item…: This command brings up a list dialog to select an item you want to remove from the menu.
Clear Menu: This item deletes all the currently defined user items.

Menu Shortcuts

You can associate key bindings to the items in the User Menu using the Menu Shortcut field in the New Item or Edit Item dialog windows.

Known problems

Please report any problem or bug you encounter in Alpha's Bug Tracker.

License and Disclaimer

Copyright (c) 2001-2019, Bernard Desgraupes.
All rights reserved.
The User Menu package is free software and distributed under the terms of the new BSD license:
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Bernard Desgraupes nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BERNARD DESGRAUPES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.