Quick Help Editor

The Quick Help Editor provides a way to display small help comments to you. These quickhelp s can be used in any palette or menu item and can help reduce the amount of on-line documentation needed for your projects. Following are descriptions of the various buttons, commands, and fields used in the Quick Help Editor.

Add Button. Used to add quickhelp items. The default name is defaultX, where X is an integer representing the next unused integer. An item must be added before you can add text and give it a caption.

Remove Button . Removes the current quickhelp item selected. If no quickhelp item is selected, nothing will happen.

Name. Corresponds to the name of the quickhelp item. This name is used in the dropdown list of the palette and menu editors. All names must be unique. To change the name select the item you wish to change, highlight the text in the name field, and replace with the new name you wish to use.

Title. The string that appears at the top of the quickhelp dialog box. To change the title, select a quickhelp item, highlight the text in the title field, and replace with the new title.

Main Text Field . The dialog part of the quickhelp dialog box. The quickhelp dialog box can show text as either bolded or normal. To bold the text, place two returns after the line of text. To make the text normal, only use one return. View the example that follows. The Quick Help Editor appears as shown here.

The Quick Help dialog box appears as shown here.

Test Button . The Test button will enable you to view the quickhelp dialog.

Note The Don't show this window again checkbox is disabled in test mode. Checking it has no effect.

Quick Help Dialog

The quickhelp dialog is the dialog box that pops up when a menu or palette item is selected. It will only function if the palette or menu item has been assigned a quickhelp name. It is a scrollable table that will expand horizontally to fit longer lined text and scroll vertically to show all lines of text.

"Don't Show This Window Again" Checkbox

The checkbox will turn off the quickhelp dialog for that quickhelp name.

Note Any palette or menu item that shares the quickhelp name will also be disabled.

Quick Help Config File

The quickhelp information regarding a studio project is stored in the $HOME\hpeesof\config directory with the file named after the project name. The format is the quickhelp name followed by a =TRUE or =FALSE. This corresponds to the Don't Show This Window Again Checkbox. All names default to TRUE which means all names will show the quickhelp dialog box when the palette or menu is selected. If the box gets checked, the corresponding name in the config file gets changed to name=FALSE, where name is the quickhelp registered name.

Note To manually turn on the quickhelp dialog box for a quickhelp name, open the corresponding config file and change the boolean value to TRUE, and to turn off the dialog box. change the value to FALSE.