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

# fz_fuim_new_check_edit

Description

Creates a new checkbox item.
Pass FZ_FUIM_NONE for check_id to not assign a specific item id. An id will be created and assigned to each item.
The checkbox item id is returned by the function and the edit item id is returned in edit_indx.
Pass FZ_FUIM_ROOT for parent if there is no parent group.
item_func is an optional function that is called to handle actions occurring to this item.

Plugin Prototype

short fz_fuim_new_check_edit(

fz_fuim_tmpl_ptr | fuim_tmpl,
short | parent,
short | check_id,
char * | check_str,
short | edit_id,
fzrt_int | edit_flags,
fz_fuim_item_func | item_func,
void * | item_data,
short * | edit_indx )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

check_id [Input]

checkbox item id

check_str [Input, Optional]

checkbox title

Default Value: a checkbox item without a title is created

edit_id [Input]

edit box item id

edit_flags [Input]

edit flags

item_func [Input, Optional]

item function

item_data [Input, Optional]

data to pass to item function
if item_func is NULL, this is ignored

edit_indx [Result, Optional]

edit box item id

Returns

Checkbox item id

Availability

5.0.0.0

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h