DH_PopupMenu 2.1

Function:

Provides a popup menu for list entry selection.

Input:

Show Menu:   Bool connection that opens dialog on change from TRUE to FALSE. (mouse up)

The menu can be displayed either using the Bool "Show Menu" input, or by clicking on the module's transparent rectangular area on the panel. 

Outputs:

List:   Connects to a List Entry pin.

Index:  Index of the selected item as an integer, numbered from 0.

Selection: Text of the selected item.

Menu Open : True while menu is being displayed; False otherwise.

Parameters:

Multiple Columns:   "On" breaks the list into columns at a specified number of rows. "Off" displays a single, scrolling list.

Column Separators:  "On" displays a vertical line separating the columns. "Off" displays columns without a separator.

Max Rows:  Specifies the numbers of rows per column.

Formatting:

You can format your menu with horizontal separators, non-selectable headings, and forced column breaks if you use DH_TextList or DH_TextList2 to create a custom list. DH_PopupMenu will recognize the following as special formatting characters if they start with a > as the 1st character in an item:

>--- ; (one or more hyphens, followed by a semicolon to end the line) inserts a horizontal separator.

>~ (tilde) at the beginning of an item marks it as non-selectable for category headings and the like.

>| (vertical bar) at the beginning of an item forces a column break with a vertical bar separator.

>] (right square bracket) at the beginning of an item forces a column break without a vertical bar separator.

Note that the column breaks and vertical separators created using formatting characters are independent of those that result from the parameter settings for Multiple Columns, Column Separators, and Max Rows. To avoid confusion, it's probably better to use one method or the other, but not both.

Notes:

Only the name of the module appears on the panel view. Drag the name to the position where you want the menu to pop up on the panel. If you like, you can remove the name, as in the panel image on the right at the top of the page, so that the control will be invisible when the menu is not popped up.

While you are working in SynthEdit building your project, the same DH_PopupMenu control may appear in several different windows at the same time: in both structure and panel views, and in containers and parent containers. The menu will only pop up in one place, which will be the last of these views to have been opened. This may cause some confusion until you get used to it, because the popup may not appear in the same window where you clicked the button. This should not be a problem in your finished product, because there the control will only appear in one place.