formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Lists
Description
Creates a list.
This must be called first when creating a list.
Pass FZ_FUIM_ROOT for parent if there is no parent group.
Pass FZ_FUIM_NONE for item_id to not assign a specific list item id.
An id will be created and assigned to the group and returned.
list_type describes how the list will handle clicks.
width is the width of the list in pixels.
num_rows is the number of rows to be displayed in the list.
If there is a title bar, it is not counted towards the number of rows.
num_cols is the number of columns to be displayed in the list.
row_height sets the height of the rows in pixels.
To set the row heights to be just large enough for the text items, pass -1 for
row_height.
list_ptr returns a pointer to the list structure.
list_ptr should be saved to allow for any future calls on the list.
Both the row and column indices are 0 based.
If there is a title row, it is -1.
Plugin Prototype
fzrt_int fz_fuim_new_list(
fuim_tmpl, | |
fzrt_int | parent, |
fzrt_int | id, |
list_type, | |
fzrt_int | list_flags, |
fzrt_int | width, |
fzrt_int | num_rows, |
fzrt_int | num_cols, |
fzrt_int | row_height, |
list_ptr ) |
Parameters
fuim_tmpl [Input]
fuim manager
parent [Input]
parent group
id [Input]
list item id
list_type [Input]
list type
list_flags [Input]
list flags
Bit Flag Type: fz_fuim_list_enum
width [Input]
list width
Range: width > 0
num_rows [Input]
number of rows
Range: num_rows > 0
num_cols [Input]
number of columns
Range: num_cols > 0
row_height [Input]
height of a row
Range: row_height > 0 -1
list_ptr [Result]
list pointer
Returns
List id
Availability
5.0.0.0
Function Set
Defined in