< Previous | Contents | Manuals Home | Boris FX | Next >
Callback Function Return Values
The value returned from any callback function in a detached panel can be a keyed (associative) list that can control additional functions, as follows. This functionality does not exist for normal non-detached Sizzle dialog panels.
accept: string Allows the default undo-system name to be overridden with a more human-friendly value.
cancel: int If the int is nonzero, any preset or scene changes are canceled, ie undone.
combine: int Attempt to consolidate consecutive same- name undo items, notably for typing in a string input field.
noReload: int If the int is nonzero, the ReloadPanel call that normally occurs at the start of a SynthEyes UI redraw is suppressed during the redraw that normally occurs at the completion of this callback. This value doesn’t matter if noRedraw is turned on.
noRedraw: int Normally a scene-level redraw occurs after the callback returns. If the int is nonzero, no redraw occurs, which may be convenient to avoid overwriting a field in which the user is typing during a ReloadPanel call.
rv: int The integer return value ultimately reported to SynthEyes internals, notably for the ClosingDetached callback to control whether or not the detached window closes.
©2025 Boris FX, Inc. — UNOFFICIAL — Converted from original PDF.