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

fz_fuim_new_scroll_bar

Description

Creates a new scroll bar item.
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_scroll_bar(

fz_fuim_tmpl_ptr

fuim_tmpl,

short

parent,

short

id,

fzrt_int

flags,

fz_fuim_item_func

item_func,

void *

item_data,

short

scroll_line,

short

scroll_page )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

id [Input]

scroll bar item id

flags [Input]

construction flags

Bit Flag Type: fz_fuim_flag_enum

item_func [Input, Optional]

item function

item_data [Input, Optional]

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

scroll_line [Input]

number of lines to scroll by when the arrow buttons are clicked

scroll_page [Input]

number of lines to scroll by when the empty area of the scroll bar is clicked

Returns

Scroll bar item id

Availability

5.0.0.0

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h