EtsT_Obj_Dbox_Display_Handler
Abstract
Callback: Used to display a new name for an existing attribute in the attribute’s dialog box.
Syntax
<object_dbox_display_handler_name> (attr_name, orig_object, copy_object, display_str)
| Argument | Type | Description |
|---|---|---|
attr_name |
const char * |
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. |
display_str |
char * |
New value. |
Return Type
EtsT_Obj_Dbox_Display_Options
Only value available is EtsC_Obj_Dbox_Display_Option.
Header
ets_api_obj_dbox.h
Details
An application calls an object dbox display handler whenever the object attribute dialog box is drawn or redrawn. You can use this handler to display a different name for an attribute: for example, to display “High Threshold” or “Low Threshold” depending on a threshold attribute’s current setting. To change the attribute’s displayed name, copy the new name to the character buffer referenced by display_string. This is a pre-allocated buffer of 2048 characters; it is not allocated or deallocated by this handler.
Changing an attribute’s displayed name has no effect on the original attribute name.
This handler has no return options defined.
Callbacks of this type are registered as the Display Handler in an attribute’s Enter ETS Handlers dialog box (see “Active Attributes“ on page 51).