formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_select_obsolete

Description

Tool select (Recommended). This function is called by formZ when the tool is selected by the user. The user can select the tool by clicking on its icon or executing a key shortcut. For FZ_TOOL_KIND_OPERATOR tools, this is where action is performed. For FZ_TOOL_KIND_MODIFIER tools, this is where the state is changed.
The fz_fuim_prompt_name function can be called to set the name of the tool in the prompts palette. If this function is not called then the tools name is used as the in the prompts palette. The fz_fuim_prompt_line function should be called to set the first prompt instruction to the user.

Plugin Prototype

fzrt_error_td fz_tool_cbak_select_obsolete(

fzrt_int | windex )

Parameters

windex [Input]

project window index

Returns

TRUE for handled, FALSE for if not

Availability

5.0.0.0

See Also

,, fz_fuim_prompt_name, fz_fuim_prompt_line

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h