ADC Home > Reference Library > Reference > Cocoa > Events & Other Input > NSInputManager Class Reference >

Next Page > Hide TOC

NSInputManager Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/AppKit.framework
Availability
Available in Mac OS X v10.0 and later.
Companion guide
Declared in
NSInputManager.h

Overview

NSInputManager is one of the three players in the Cocoa text input management system. The input manager acts as a proxy between "NSInputServer" and text views. You never have to instantiate or subclass NSInputManager, and unless you are implementing a text view that does not inherit from NSTextView, you never have to directly access its methods either.

If an application needs more complex text handling than the standard Cocoa text view classes can provide, then it will use its own text view class that implements the NSTextInput protocol, and that class will call NSInputManager’s methods. The current input manager’s input server will call some of the text view’s NSTextInput protocol methods.

The wantsToDelayTextChangeNotifications, wantsToHandleMouseEvents, and wantsToInterpretAllKeystrokes methods call methods of the same names on the input manager’s current input server and return the result.

Adopted Protocols

NSTextInput

Tasks

Creating Input Managers

Getting Active Input Manager

Handling Events

Getting Input Server Information

Deprecated

Class Methods

currentInputManager

The current input manager is the one that has been chosen to handle keyboard events at the time this method is called.

+ (NSInputManager *)currentInputManager

Discussion

Don’t cache the return value, because the user can switch to a different input manager at any time.

Availability
Declared In
NSInputManager.h

cycleToNextInputLanguage:

Deprecated.

+ (void)cycleToNextInputLanguage:(id)sender

Availability
Declared In
NSInputManager.h

cycleToNextInputServerInLanguage:

Deprecated.

+ (void)cycleToNextInputServerInLanguage:(id)sender

Availability
Declared In
NSInputManager.h

Instance Methods

handleMouseEvent:

- (BOOL)handleMouseEvent:(NSEvent *)theMouseEvent

Discussion

Forwards a mouse event passed in theMouseEvent to the input server. If wantsToHandleMouseEvents returns YES, then the text view must forward all mouse events that occur within it. As usual, a return value of NO means that the text view should proceed with handling the event.

For additional information see the NSInputServerMouseTracker class.

Availability
Declared In
NSInputManager.h

image

Deprecated.

- (NSImage *)image

Availability
Declared In
NSInputManager.h

initWithName:host:

- (NSInputManager *)initWithName:(NSString *)inputServerName host:(NSString *)hostName

Discussion

Cocoa constructs an NSInputManager automatically. This method is an implementation detail. You will never call this method.

Availability
Declared In
NSInputManager.h

language

Returns the Language property from the input server’s Info file, or nil if none is specified there.

- (NSString *)language

Discussion

For additional information, see “Deploying Input Servers”.

Availability
Declared In
NSInputManager.h

localizedInputManagerName

Returns the name of the input server as it appears in the Edit>Input submenu.

- (NSString *)localizedInputManagerName

Discussion

This value comes from the input server’s Info file.For additional information, see “Deploying Input Servers”.

Availability
Declared In
NSInputManager.h

markedTextAbandoned:

The input server must abandon whatever it was doing with marked text.

- (void)markedTextAbandoned:(id)client

Discussion

The NSTextView object client calls this when the user clicks outside the marked text (anywhere other than the beginning of marked text, the end of marked text, or in between), then NSTextView promotes the marked text to normal text as if it had been inserted. A custom text view is free to choose not to keep the marked text.

Availability
See Also
Declared In
NSInputManager.h

markedTextSelectionChanged:client:

The user clicked at the beginning of marked text, the end of marked text, or in between, or the user made a selection within the marked text in the client text view.

- (void)markedTextSelectionChanged:(NSRange)newSel client:(id)client

Discussion

The range newSel is relative to the beginning of the marked text.

Availability
See Also
Declared In
NSInputManager.h

server

Deprecated.

- (NSInputServer *)server

Availability
Declared In
NSInputManager.h

wantsToDelayTextChangeNotifications

A YES return value tells the sender that only a call to its insertText:client: method constitutes a modification to its text storage.

- (BOOL)wantsToDelayTextChangeNotifications

Discussion

A NO return value tells the sender that all text given to it, either by insertion or as part of marked text, should constitute a modification to its text storage. The sender may for example want to filter all text that is part of a modification but leave marked text unfiltered.

Availability
See Also
Declared In
NSInputManager.h

wantsToHandleMouseEvents

Returns YES if the sender should forward all mouse events within the text view to the input server.

- (BOOL)wantsToHandleMouseEvents

Availability
See Also
Declared In
NSInputManager.h

wantsToInterpretAllKeystrokes

Returns YES if the server wants all keystrokes to be sent to it as characters.

- (BOOL)wantsToInterpretAllKeystrokes

Discussion

This method is needed only by the inner workings of Cocoa. You will probably not need to call this method.

Availability
See Also
Declared In
NSInputManager.h

Next Page > Hide TOC

© 2007 Apple Inc. All Rights Reserved. (Last updated: 2007-04-01)

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.