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

fz_fuim_new_text_info

Description

Creates a new text info item using a preformatted string (titl_str). 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(

fz_fuim_tmpl_ptr

fuim_tmpl,

short

parent,

short

id,

fzrt_int

flags,

char *

titl_str,

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

titl_str [Input]

[Input, Optional]

Default Value: an empty text info item is created

width [Input, Optional]

width of the info box (in characters)

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

Range: width >= 0

height [Input, Optional]

height of the info box (in rows)

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_char,,, fz_fuim_new_text_info_ushort, , fz_fuim_new_text_info_uint, fz_fuim_new_text_info_float, fz_fuim_new_text_info_double

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h