geSetEnablePredicate

geSetEnablePredicate(
r_menu
t_appName
n_enablePredicate
)

Description

Sets the enable predicate of the r_menu for t_appName to n_enablePredicate.

The enable predicate is a bit mask that specifies when menu should be enabled. Each bit in n_enablePredicate corresponds to an application-defined status, for example “window is editable” or “can create instances.”

Each application can set its own enable predicate, which means menu can have multiple enable predicates. For menu to be enabled, all the status bits for all enable predicates must be TRUE. When geUpdateWindowMenus is called, the enable predicates of menu are compared, logically ANDed, with the corresponding window status for appName. When all the status bits specified in the enable predicates for all applications are TRUE, menu is enabled. Otherwise, menu is disabled.

Arguments

r_menu	The menu whose enable predicate you want to set. This is an array name, not the symbolic name, of a menu that is returned by hiCreateMenuItem or hiCreateSliderMenuItem.
t_appName	The text or symbolic name of the application for which this enable predicate is set.
n_enablePredicate	An integer bit mask that specifies when menu needs to be enabled in t_appName.

Value Returned

None

Examples

Sets the enable predicate of the menu.

leCreateConicsItem
=> array[8]:108643592
geSetEnablePredicate(leCreateConicsItem ’default lecLayoutIsEditable)
=> 2

Related Topics

Automatic Menu Enabling Functions

Return to top