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

# fz_fuim_setup_windex_func

Description

Interface setup function prototype. Use this prototype to create a user interface template that is invoked by the driver function: fz_fuim_dlog_drive_windex. This function is called to create fuim template content for dialogs and palettes. This function should first call fz_fuim_tmpl_init to initialize the given template and then call functions to create the desired items (functions that start with fz_fuim_new_) and bind them to their corresponding storage (functions that start with fz_fuim_item_). The template utility functions (functions that start with fz_fuim_tmpl_) can be used to add additional functionality to the template.
The windex and tmpl_data parameters are the corresponding parameters that are provided by the driver function and is how to get external information into the setup function without the need for global variables.

Plugin Prototype

fzrt_error_td fz_fuim_setup_windex_func(

fzrt_int | windex,
fz_fuim_tmpl_ptr | tmpl_ptr,
fzrt_ptr | tmpl_data )

Parameters

windex [Input]

project window index passed into fz_fuim_setup_windex

tmpl_ptr [Input]

pointer to the template provided by the driver. Needed for additional fuim function calls

tmpl_data [Input]

data pointer that is provided by the driver function

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_setup_func, fz_fuim_setup_data_func,

Defined in

fz_fuim_api.h