tbl_cell_clear Callback Type
Function prototype:
function funcname (doc, target, content , span, attrs, op)
tbl_cell_clear is called before the
tbl_cell_clear ACL function is executed. It may be called by the user from ACL or internally by the table editor user interface.
Arguments
• doc is the identifier of the document containing the target.
• target is the table object ID (toid) of the cell to be cleared.
• content is a boolean: one (1) if the cell's content is going to be discarded, zero (0) if the cell's content is not being cleared.
• span is a boolean: one (1) if the cell is going to be unspanned, zero (0) if the cell's spanned state is not being changed.
• attrs is a boolean: one (1) if the cell's attributes are going to be set to their default values, zero (0) if the cell's attributes are not being changed.
• op is the function callback operation. Callbacks are called twice in succession with op specifying the stage of callback operation.
1. op == 1 first call — The returned argument specifies whether the execution should continue or be stopped:
▪ 0 — Continue callback processing.
▪ -1 — Stop further callback processing.
2. op == 2 second call — Occurs unless the processing was stopped during the first call. The returned argument allows or prevents basic Arbortext Editor processing after all callbacks have been called:
▪ 0 — Basic Arbortext Editor processing allowed.
▪ -1 — Basic Arbortext Editor processing prevented.
|
|
Unlike many other Arbortext Editor callbacks, the table editor does not expect the callback function to perform the operation itself and return -1. If the callback function returns -1, the table editor will display an error message.
|
