IMKMouseHandling Protocol Reference

Adopted by
Framework
System/Library/Frameworks/InputMethodKit.framework
Availability
Available in OS X v10.5 and later.
Declared in
IMKInputController.h

Overview

The IMKMouseHandling protocol defines methods that your input method can implement to handle mouse events.

Tasks

Handling Mouse Events

Instance Methods

mouseDownOnCharacterIndex:coordinate:withModifier:continueTracking:client:

Handles mouse-down event send to an input method. (required)

-(BOOL)mouseDownOnCharacterIndex:(NSUInteger)index coordinate:(NSPoint)point withModifier:(NSUInteger)flags continueTracking:(BOOL*)keepTracking client:(id)sender
Parameters
index

The index within the sender’s text storage where the mouse-down event occurred.

point

The point at which the mouse-down event occurred.

flags

The modifier keys.

keepTracking

Set this parameter to YES if you want to receive subsequent mouse-moved and mouse -up events.

sender

The client object.

Return Value

YES if handled; otherwise NO.

Discussion

Implement this method if your input method handles mouse-down events.

Availability
  • Available in OS X v10.5 and later.
Declared In
IMKInputController.h

mouseMovedOnCharacterIndex:coordinate:withModifier:client:

Handles a mouse-moved event sent to an input method. (required)

-(BOOL)mouseMovedOnCharacterIndex:(NSUInteger)index coordinate:(NSPoint)point withModifier:(NSUInteger)flags client:(id)sender
Parameters
index

The index within the sender’s text storage where the mouse-moved event occurred.

point

The point at which the mouse-moved event occurred.

flags

The modifier keys.

sender

The client object.

Return Value

YES if handled; otherwise NO.

Discussion

Implement this method if your input method handles mouse-moved events.

Availability
  • Available in OS X v10.5 and later.
Declared In
IMKInputController.h

mouseUpOnCharacterIndex:coordinate:withModifier:client:

Handles a mouse-up event sent to an input method. (required)

-(BOOL)mouseUpOnCharacterIndex:(NSUInteger)index coordinate:(NSPoint)point withModifier:(NSUInteger)flags client:(id)sender
Parameters
index

The index within the sender’s text storage where the mouse-up event occurred.

point

The point at which the mouse-up event occurred.

flags

The modifier keys.

sender

The client object.

Return Value

YES if handled; otherwise NO.

Discussion

Implement this method if your input method handles mouse-up events.

Availability
  • Available in OS X v10.5 and later.
Declared In
IMKInputController.h