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

# fz_fuim_list_drag_func

Description

The list drag callback function.
This callback is designed to allow handling of mouse click drags in the list.
row_indx is the index to the row item where the drag started and will always be greater than or equal to 0 and less than the number of items in the list.
row_dist is the number of rows the item was dragged. Negative numbers indicate the item was dragged up. Positive numbers indicate the item was dragged down.
This callback will not be called if an item is dragged to itself (i.e. row_dist will never be 0). Return whether the move was successfully handled in did. If did isn't set, the move is assumed to have been handled.
This callback is only valid on lists of type FZ_FUIM_LIST_TYPE_ONE and FZ_FUIM_LIST_TYPE_MULTI. Drags in lists of type FZ_FUIM_LIST_TYPE_SYSTEM are handled with fz_fuim_list_click.

Plugin Prototype

fzrt_error_td fz_fuim_list_drag_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | row_indx,
fzrt_int | row_dist,
fzrt_boolean * | did )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

row_indx [Input]

row index

row_dist [Input]

number of rows moved. negative numbers are up, positive numbers are down

did [Result, Optional]

was the drag handled
TRUE if handled, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_list_enum, fz_fuim_list_set_drag_func

Defined in

fz_fuim_list_api.h