EtsT_Obj_Dbox_Confirm_Handler
Abstract
Callback: Used to update an attribute object with a user’s proposed changes.
Syntax
<object_dbox_confirm_handler_name> (attr_name, orig_object, copy_object)
| Argument | Type | Description |
|---|---|---|
attr_name |
const char * |
Name of the attribute object. |
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_object
EtsC_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
Header
ets_api_obj_dbox.h
Details
An application calls an object dbox confirm handler when a user changes the attribute and then clicks OK in the attribute dialog box. Normally, an object dbox 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, an object dbox 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 EtsC_Obj_Dbox_Confirm_Value_Invalid.
Callbacks of this type are registered as the Confirm Handler in an attribute’s Enter ETS Handlers dialog box (see “Active Attributes“ on page 51).