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

# fz_fuim_new_preview

Description

Creates a preview item encosed in a border with an optional title. Also contained within the border are tool icons for manipulating the view. Other tool icons can be added by passing an array of tool command ids to fuim_pview_opts_set_cmds.

Plugin Prototype

fzrt_int fz_fuim_new_preview(

fz_fuim_tmpl_ptr | fuim_tmpl,
short | parent,
short | cust_id,
fzrt_int | fuim_flags,
char * | title_str,
fz_fuim_pview_opts_ptr | pview_opts,
void * | pview_data,
fzrt_int * | grup_id )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

cust_id [Input]

custom item id

fuim_flags [Input]

construction flags

Bit Flag Type: fz_fuim_flag_enum

title_str [Input]

[Input, Optional]

Default Value: a custom item item without a title is created

pview_opts [Input]

custom item options created by

pview_data [Input]

pointer to the data

grup_id [Result]

the id of the group conteining the preview item

Returns

item id of the preview custom control

Availability

7.0.0.0

See Also

, fz_fuim_pview_opts_finit, fuim_pview_opts_set_cmds

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h