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

# fz_fuim_new_text_info_long

Description

Creates a new text info item using a fzrt_int. A text info item has an uneditable box that displays information.
The size of the box can be set with the width and height parameters. Pass FZ_FUIM_NONE for id to not assign a specific item id. An id will be created and assigned to the item.
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_text_info_long(

fz_fuim_tmpl_ptr | fuim_tmpl,
short | parent,
short | id,
fzrt_int | flags,
fz_fuim_format_int_enum | format,
fzrt_int * | data_ptr,
short | persist,
short | width,
short | height,
fz_fuim_item_func | item_func,
void * | item_data )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

id [Input]

text info item id

flags [Input]

construction flags

Bit Flag Type: fz_fuim_flag_enum

format [Input]

formatting option

data_ptr [Input]

text info contents

persist [Input]

should the data_ptr be stored with the item
if TRUE, the data_ptr persists as fzrt_int as the item exists, otherwise the data_ptr is only used on setup and doesn't persist

width [Input, Optional]

width of the info box (in characters)

Default Value: wide enough to hold the formatted data_ptr (pass 0 for default)

Range: width >= 0

height [Input, Optional]

height of the info box (in rows) (pass 0 for default)

Default Value: 1 row high (pass 0 for default)

Range: height >= 0

item_func [Input, Optional]

item function

item_data [Input, Optional]

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

Returns

Text info item id

Availability

5.0.0.0

See Also

fz_fuim_new_text_info,,,, ,,,

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h