formZ SDK | 4.0 Call Back Reference | Command | Tool

fz_tool_cbak_icon_file_obsolete

Description

Tool icon from file (Optional). This function is called by formZ to load an icon for the tool from an image file. The image file can be in any supported image file format (or of an image format which is an image file translator plugin). It is recommended to use the TIFF image format as it is a cross platform supported format and is always present. The source graphics are identified in the file by indicating the top left corner of the graphic in the file. In addition to the graphic, a mask can be provided for use when the icon is highlighted. A single file can be used for multiple icons across a variety of plugins by creating a grid of icons in the file and specifying the location for each icon.

Plugin Prototype

fzrt_error_td fz_tool_cbak_icon_file_obsolete(

fz_fuim_icon_enum

which,

fzrt_floc_ptr

floc,

fzrt_int *

hpos,

fzrt_int *

vpos,

fzrt_floc_ptr

floc_mask,

fzrt_int *

hpos_mask,

fzrt_int *

vpos_mask )

Parameters

which [Input]

which style of icon to load.

floc [Result]

file location of file which contains the icon.

hpos [Input]

left horizontal location of icon data in file.

vpos [Input]

top vertical location of icon data in file.

floc_mask [Result, Optional]

file location of file which contains the icon mask data.

hpos_mask [Input]

left horizontal location of icon mask data in file.

vpos_mask [Input]

top vertical location of icon mask data in file.

Returns

Error codes

Availability

5.0.0.0

See Also

Function Set

fz_tool_cbak_fset


Defined in

fz_tool_api.h