---

Ink-Related Carbon Events

Table A-1 lists the Carbon event kinds and event parameters associated with the Carbon event class kEventClassInk. These constants are part of the Carbon Event Manager. See Handling Carbon Events for more information on using the Carbon Event Manger. See Using Ink Services in Your Application for information on obtaining Ink-related Carbon events and the associated event parameters.

Descriptions for each event parameters are as follows:

• kEventParamEventRef A reference to the original mouse event that spawned this kEventInkPoint event.

• kEventParamInkGestureKind An “Editing Gestures” constant. These constants specify editing actions.

• kEventParamInkGestureBounds The rectangle that defines the bounds of a gesture.

• kEventParamInkGestureHotspot The location to which a targeted gesture should apply.

• kEventParamInkTextRef A reference to an opaque Ink text object (InkTextRef).

• kEventParamInkTextKeyboardShortcut A Boolean value that indicates whether the Ink associated with an Ink text object (InkTextRef) is likely a keyboard equivalent. The value is TRUE if the Command or Control key is pressed and the top-choice alternate text is a single character. Checking for this parameter provides an easy way for you to determine if an InkTextRef is likely to be a keyboard shortcut instead of text. Otherwise, to determine whether the Ink text is a keyboard shortcut, you would need to extract the kEventParamInkTextRef parameter, retrieve the CFStringRef for the text, determine the length of the string, and then check for modifier keys. In most cases, you don’t need to handle this event, and can immediately return eventNotHandledErr.

Table A-2 lists the event parameters for the Carbon event kind kEventAppIsEventInInstantMouser which is of class kEventClassApplication. This event is sent to your application when the system needs to determine if the global mouse location of the given event coincides with an instant-mousing area. An instant-mousing area is an area where a mouse-down event should only be interpreted as a mousing action; the event should not generate Ink.

The instant-mousing event is dispatched only when a stylus is initially pressed to a tablet, at the beginning of a phrase, before Ink Services has determined whether the user is writing or not. Once the user has begun writing, stylus-down actions do not generate instant-mousing events. How your application responds to this event determines whether Ink Services treats the stylus-down action as Ink or not. The instant-mousing status of all standard Carbon and Cocoa controls is determined automatically. You need only install an instant-mouse event handler if your application defines custom controls you want to designate as instant mousing areas.

Descriptions for each event parameter are as follows:

• kEventParamEventRef A reference to the original mouse event that spawned this kEventParamIsInInstantMouser event. This mouse event contains the point your application must evaluate to determine if the point is in an instant-mousing area.

• kEventParamIsInInstantMouser A Boolean value that specifies whether the point is in an instant-mousing area (TRUE) or not (FALSE). Your application must set this parameter to define instant-mousing screen regions.

---