Part I: User Interface

12 Graffiti Shift

GraffitiShift Functions

GsiEnable

GsiEnabled

GsiInitialize

GsiSetLocation

GsiSetShiftState

This chapter provides reference material for the shift indicator API, declared in the header file GraffitiShift.h.

GraffitiShift Functions ^TOP^

GsiEnable Function ^TOP^

Purpose

Enable or disable the shift indicator.

Declared In

GraffitiShift.h

Prototype

void GsiEnable (
   const Boolean enableIt
)

Parameters

enableIt

true to enable, false to disable.

Returns

Returns nothing.

Comments

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

GsiEnabled Function ^TOP^

Purpose

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

Declared In

GraffitiShift.h

Prototype

Boolean GsiEnabled (
   void
)

Parameters

None.

Returns

true if enabled, false if not.

GsiInitialize Function ^TOP^

Purpose

Initialize the global variables used to manage the shift indicator.

Declared In

GraffitiShift.h

Prototype

void GsiInitialize (
   void
)

Parameters

None.

Returns

Returns nothing.

GsiSetLocation Function ^TOP^

Purpose

Set the display-relative position of the shift indicator.

Declared In

GraffitiShift.h

Prototype

void GsiSetLocation (
   const Int16 x,
   const Int16 y
)

Parameters

x, y

Coordinate of left side and top of the indicator.

Returns

Returns nothing.

Comments

The indicator is not redrawn by this routine.

Do not use this function in application code. It is used internally by the Form Manager. If you need to change the shift indicator's location to support devices with a dynamic input area, see knowledge base article 507 for sample code that shows you how to do so.

GsiSetShiftState Function ^TOP^

Purpose

Set the shift indicator.

Declared In

GraffitiShift.h

Prototype

void GsiSetShiftState (
   const UInt16 lockFlags,
   const UInt16 tempShift
)

Parameters

lockFlags

glfCapsLock or glfNumLock.

tempShift

The current temporary shift.

Returns

Returns nothing.

Comments

This function affects only the state of the UI element, not the underlying Graffiti^® or Graffiti 2 engine.

See Also

GrfSetState()