formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Lists
Description
The list draw item callback function.
This callback is designed to draw the item in a specified row and column of a list.
This is called before the get string callback function.
Both the draw item function and the get string function can be called for the same item.
If both functions exist for an item, the draw item is handled first followed by the get string.
In this case, the text will be drawn on top of the item.
Unlike the get string function, this callback can be used on the title row,
in which case row_indx will be passed as -1.
rect is the rectangle, in screen coordinates, of where the item should be drawn.
It is the responsibility of the draw function to only draw within the specified rectangle.
If the item drawn is smaller than the rectangle, the rectangle where the item was
drawn should be passed back through rect.
row_indx is the index to the row item and will always be greater than or equal to -1 and less
than the number of items in the list.
col_indx is the index to the column and will always be greater than or equal to 0 and less
than the number of columns in the list.
Return whether an item was drawn in did.
Plugin Prototype
fzrt_error_td fz_fuim_list_draw_item_func(
fuim_tmpl, | |
list_ptr, | |
fzrt_int | row_indx, |
fzrt_int | col_indx, |
rect, | |
did ) |
Parameters
fuim_tmpl [Input]
fuim manager
list_ptr [Input]
list pointer
row_indx [Input]
row index
col_indx [Input]
column index
rect [Input, Result]
rectangle of item to draw
did [Result]
was an item drawn
TRUE if item was drawn, FALSE otherwise
Returns
Error codes
Availability
5.0.0.0
See Also
fz_fuim_list_set_draw_item_func
Defined in