Confirm Handler Functions
Abstract
Use this handler to update an attribute object with a user’s proposed changes
Syntax
<confirm handler name> (attr_name, orig_object, copy_object)
| Argument | Type | Description |
|---|---|---|
attr_name |
const char * |
Pointer to a string containing the object name |
orig_object |
EtsT_Obj_Handle |
Handle for the original attribute object |
copy_object |
EtsT_Obj_Handle |
Handle for a copy of the original attribute object containing the proposed changes. |
Return Type
EtsT_Obj_Dbox_Confirm_Options
One of the following constants:
EtsC_Obj_Dbox_Confirm_None—indicates that this handler has validated the attribute values of copy_object and the values have been copied to orig_objectEtsC_Obj_Dbox_Confirm_Value_Invalid—indicates that the set of attribute values contained in copy_object are invalid and the attribute values in orig_object have not been changed
Details
An application calls a confirm handler when a user changes the attribute and then clicks OK in the attribute dialog box. Normally, a confirm handler is called only when a user directly modifies an attribute; if a user changes an object’s attribute via the “Apply changes to selected objects” option, a confirm handler is not called. This behavior can be changed with the “edit_attr_confirm_handler_for_all“ preference.
You can use this handler to validate a set of multiple attribute changes. If the changes are invalid, return with EtsC_Obj_Dbox_Confirm_Value_Invalid.