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

# fz_fuim_list_set_string_func

Description

The list set string callback function.
This callback is designed to set the string in a specified row and column of a list.
Both this callback and fz_fuim_list_click_edit_func must be defined in order to allow for strings to be edited in the list. The click edit callback is called first, to verify if the selected cell can be edited. If so, the user is able to edit the text. When the user is done, the set string callback is called to update the text of the cell.
row_indx is the index to the row item and will always be greater than or equal to 0 and less than the number of items in the list.
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.
max_len is the maximum length of str and str must not exceed max_len.
Return whether the string was set in did.
Strings in the title row are not handled by this callback but are instead set by calling .

Plugin Prototype

fzrt_error_td fz_fuim_list_set_string_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | row_indx,
fzrt_int | col_indx,
char * | str,
fzrt_int | max_len,
fzrt_boolean * | did )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

row_indx [Input]

row index

col_indx [Input]

column index

str [Input]

string

max_len [Input]

maximum length of string

did [Result]

was the string set
TRUE if string was set, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_list_set_set_string_func, fz_fuim_list_click_edit_func,

Defined in

fz_fuim_list_api.h