formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Lists

# fz_fuim_list_click_func

Description

The list click callback function.
This callback is designed to allow handling of single mouse clicks in the list.
row_indx is the index to the row item and will always be greater than or equal to -1 and less than the number of items in the list.
If row_indx is -1, the click occurred in the title row.
col_indx is the index to the column and will always be greater than or equal to 0 and less than the number of columns in the list.
In lists of type FZ_FUIM_LIST_TYPE_ONE, the picked parameter is always TRUE. In this list type, if a picked list is being maintained (i.e. the picked status callback is defined), all other items in the list should be marked not-picked except the one that is being handled.
In lists of type FZ_FUIM_LIST_TYPE_MULTI, the picked parameter will be TRUE to indicate the row was toggled on, and FALSE to indicate the row was toggled off.
In lists of type FZ_FUIM_LIST_TYPE_SYSTEM, this callback function will be called whenever a row is picked or unpicked. For example, in shift-clicking a range, all rows in the range will be called with picked set to TRUE, and any rows that were previously picked but not in the new range will be called with picked set to FALSE.
Note: Don't do any work in this callback that is of a time consuming nature since it is called on each click. This should mainly be used to update the state of other fuim items that are dependent on the item that is selected in the list.

Plugin Prototype

fzrt_error_td fz_fuim_list_click_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | row_indx,
fzrt_int | col_indx,
fzrt_boolean | picked )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

row_indx [Input]

row index

col_indx [Input]

column index

picked [Input]

is the item picked
TRUE if picked, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

Defined in

fz_fuim_list_api.h