CwSetTool

Syntax:

call CwSetTool hEffect, sToolName

        hEffect         (handle) Handle to the effect to change.

        sToolName       (string) Name of the tool to switch to.

Description:

This procedure replaces the tool of an effect with another tool. The new tool has all of its properties set to default values. If the requested tool is the same as the current tool, nothing is done.

Available tool names are:

"Custom Tool" "Bitmap" "Solid Color" "Wave" "Lens" "Emboss" "Contrast & Brightness" "Greyscale" "Color Fade" "Button" "Noise" "Pixelate" "Blur" "Sharpen"

Example:

/* Create an effect, then change its tool to "Color fade". */
w1 = CwCreateEffect("headline text", "color fade")
call CwSetPosition w1, 5.5, 4.25, 5, 4, 0, 0
call CwSetTool w1, "solid color"

Remarks:

If the current tool is the same as the requested tool, CwSetTool does nothing. There is a subtle trap here, since the new tool is usually reset to its default settings. Since CwSetTool does nothing if the desired tool is already in place, the tool retains its old settings.

Functions by NAME

Index

Functions by PURPOSE