formZ SDK | 5.0 API Reference | System | System

# fz_syst_extd_crsr_opts_parm_enum

Description

Extended cursor option parameters.

enum fz_syst_extd_crsr_opts_parm_enum {

FZ_SYST_EXTD_CRSR_SHOW_SNAP,

FZ_SYST_EXTD_CRSR_SIZE_CUSTOM,

FZ_SYST_EXTD_CRSR_SIZE_CUSTOM_SIZE,

FZ_SYST_EXTD_CRSR_SIZE_MARKER,

FZ_SYST_EXTD_CRSR_LOCK };

Members

FZ_SYST_EXTD_CRSR_SHOW_SNAP

Indicates the extended cursor is shown at the snapped position. If set, the extended cursor is shown at the snapped position if grid snap is on, otherwise the extended cursor is shown at the mouse location.
If not set, the cursor will be shown at the mouse position even if grid snap is on.

Type: fzrt_boolean

Default Value: TRUE

FZ_SYST_EXTD_CRSR_SIZE_CUSTOM

Indicates how the extended cursor size is shown. If this is set, the cursor is extended by the value in the custom pixels, otherwise the cursor is extended to the limits of the window.

Type: fzrt_boolean

Default Value: FALSE

FZ_SYST_EXTD_CRSR_SIZE_CUSTOM_SIZE

Indicates the number of pixels the extended cursor size is drawn when FZ_SYST_EXTD_CRSR_SIZE_CUSTOM is set.

Type: fzrt_int

Default Value: 40

Range: value >= 1

FZ_SYST_EXTD_CRSR_SIZE_MARKER

Indicates that a small square, which is aligned parallel to the active plane, is drawn around the location of the extended cursor. If not set, the square isn't drawn.

Type: fzrt_boolean

Default Value: TRUE

FZ_SYST_EXTD_CRSR_LOCK

Indicates that the extended cursor availabilty is locked. This prevents other code from turning the extended cursor on or off, and disables the extended cursor menu item.

Type: fzrt_boolean

Default Value: TRUE

Availability

5.0.0.0

See Also

, fz_syst_set_extd_crsr_opts

Defined in

fz_syst_api.h