formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_modf_key

Description

Tool Cancel (Optional). This function is called by formZ if a modifier key (command, shift, option ...) was pressed down, let go (up), or tabbed (down and up quickly). The tool may use this action for certain behavior modification or shortcut actions (see other formZ tools for examples).

Plugin Prototype

fzrt_error_td fz_tool_cbak_modf_key(

fzrt_int | windex,
fzrt_int | click_count,
fzrt_int | modifiers,
fz_modf_key_action | modf_key_action )

Parameters

windex [Input]

project window index

click_count [Input]

count of clicks for tool (1 for first click, 2 for second etc...)

modifiers [Input]

modifier key state (see fzrt_evnt_modifier_enum)

modf_key_action [Input]

modifier key action indicator

Returns

Error codes

Availability

7.0.0.0

See Also

fz_tool_cbak_click, fz_tool_cbak_track,fz_tool_cbak_prompt

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h