setCtlAction

Syntax

setCtlAction(int index, int action)

Arguments

index
The index of the control that should perform this action.
action
The action you want the control to perform.

Description

Sets the default action for a control. You can set the action to any of the following:
Symbolic Constant Control Action
CA_PREVIEW Updates the proxy preview window.
CA_APPLY Applies the filter to the original source image and exits the plug-in.
CA_CANCEL Exits the plug-in filter without modifying the original source image.
CA_EDIT Enters or exits source code editing mode (ignored in standalone filters).
CA_ABOUT Displays the ABOUT dialog box.
CA_RESET Resets all controls to their initial values.
CA_NONE Performs no action.
CA_SIZE Triggers a FME_SIZE (resize) event. That way you don't need to duplicate your sizing code anywhere else.

Example

// Set control 5 to apply the filter effect
setCtlAction( 5, CA_APPLY );

Also see

doAction

Comments

Everyone can add his comments about his experiences with this function here. Tips for using it are welcome, too.