Menu Choose Handler Functions
Abstract
Used to allow custom processing of a selection from an object pop-up menu.
Syntax
Menu Choose Handler Function Name (obj_handle, chosen_str_ptr)
| Argument | Type | Description |
|---|---|---|
obj_handle |
EtsT_Obj_Handle |
Handle to the object that was clicked. |
chosen_str_ptr |
const char* |
Pointer to the menu item string that was chosen. |
Return Type
EtsT_Obj_Click_Return
One of the following constants:
EtsC_Obj_Click_Continue—indicates that the application should continue handling the click.EtsC_Obj_Click_Handled—indicates that the click has been handled and the application should not do any further processing.
Details
The menu choose handler function allows a model developer to perform custom processing of an item selected by a user from an object pop-up menu. If a menu display handler function has been called in response to a right-click event and it returned EtsC_Obj_Click_Continue, the ODK application calls the corresponding menu choose handler function when the user makes a choice from the pop-up menu that was displayed.
The menu choose handler function is passed a handle to the object that was clicked and the menu item string that was selected. After processing the menu item, the function can tell the application to continue processing the event or to stop processing it.