11 Graffiti Shift

This chapter provides reference material for the Graffiti^® Shift facility, declared in the header file GraffitiShift.h.

GraffitiShift Functions

GsiEnable

Purpose

Enable or disable the Graffiti-shift state indicator.

Prototype

void GsiEnable (const Boolean enableIt)

Parameters

enableIt

true to enable, false to disable.

Result

Returns nothing.

Comments

Enabling the indicator makes it visible, disabling it makes the insertion point invisible.

GsiEnabled

Purpose

Return true if the Graffiti-shift state indicator is enabled, or false if it's disabled.

Prototype

Boolean GsiEnabled (void)

Parameters

Result

true if enabled, false if not.

GsiInitialize

Purpose

Initialize the global variables used to manage the Graffiti-shift state indicator.

Prototype

void GsiInitialize (void)

Parameters

Result

Returns nothing.

GsiSetLocation

Purpose

Set the display-relative position of the Graffiti-shift state indicator.

Prototype

void GsiSetLocation (const Int16 x, const Int16 y)

Parameters

x, y

Coordinate of left side and top of the indicator.

Result

Returns nothing.

Comments

The indicator is not redrawn by this routine.

GsiSetShiftState

Purpose

Set the Graffiti-shift state indicator.

Prototype

void GsiSetShiftState (const UInt16 lockFlags, const UInt16 tempShift)

Parameters

lockFlags

glfCapsLock or glfNumLock.

tempShift

The current temporary shift.

Result

Returns nothing.

Comment

This function affects only the state of the UI element, not the underlying Graffiti engine.

See Also

GrfSetState