Up

# NSResponder

### Authors

Scott Christley (`scottc@net-community.com`)

> Abstract class which is basis of command and event processing

Copyright: (C) 1996,1999 Free Software Foundation, Inc.

### Contents -

1. Software documentation for the NSResponder class
2. Software documentation for the NSResponder(OptionalActionMethods) category

# Software documentation for the NSResponder class

## NSResponder : NSObject

> Declared in:
>   AppKit/NSResponder.h

> Conforms to:
>   NSCoding

Availability: OpenStep
Description forthcoming.

Instance Variables
Method summary

- -cancelOperation:
- -capitalizeWord:
- -centerSelectionInVisibleArea:
- -changeCaseOfLetter:
- -complete:
- -deleteBackward:
- -deleteBackwardByDecomposingPreviousCharacter:
- -deleteForward:
- -deleteToBeginningOfLine:
- -deleteToBeginningOfParagraph:
- -deleteToEndOfLine:
- -deleteToEndOfParagraph:
- -deleteToMark:
- -deleteWordBackward:
- -deleteWordForward:
- -indent:
- -insertBacktab:
- -insertContainerBreak:
- -insertLineBreak:
- -insertNewline:
- -insertNewlineIgnoringFieldEditor:
- -insertParagraphSeparator:
- -insertTab:
- -insertTabIgnoringFieldEditor:
- -lowercaseWord:
- -moveBackward:
- -moveBackwardAndModifySelection:
- -moveDown:
- -moveDownAndModifySelection:
- -moveForward:
- -moveForwardAndModifySelection:
- -moveLeft:
- -moveLeftAndModifySelection:
- -moveRight:
- -moveRightAndModifySelection:
- -moveToBeginningOfDocument:
- -moveToBeginningOfLine:
- -moveToBeginningOfParagraph:
- -moveToEndOfDocument:
- -moveToEndOfLine:
- -moveToEndOfParagraph:
- -moveUp:
- -moveUpAndModifySelection:
- -moveWordBackward:
- -moveWordBackwardAndModifySelection:
- -moveWordForward:
- -moveWordForwardAndModifySelection:
- -moveWordLeft:
- -moveWordLeftAndModifySelection:
- -moveWordRight:
- -moveWordRightAndModifySelection:
- -pageDown:
- -pageUp:
- -scrollLineDown:
- -scrollLineUp:
- -scrollPageDown:
- -scrollPageUp:
- -selectAll:
- -selectLine:
- -selectParagraph:
- -selectToMark:
- -selectWord:
- -setMark:
- -showContextHelp:
- -swapWithMark:
- -tabletPoint:
- -tabletProximity:
- -transpose:
- -transposeWords:
- -uppercaseWord:
- -yank:
- -acceptsFirstResponder
- -becomeFirstResponder
- -doCommandBySelector:
- -encodeWithCoder:
- -flagsChanged:
- -flushBufferedKeyEvents
- -helpRequested:
- -initWithCoder:
- -insertText:
- -interfaceStyle
- -interpretKeyEvents:
- -keyDown:
- -keyUp:
- -menu
- -mouseDown:
- -mouseDragged:
- -mouseEntered:
- -mouseExited:
- -mouseMoved:
- -mouseUp:
- -nextResponder
- -noResponderFor:
- -otherMouseDown:
- -otherMouseDragged:
- -otherMouseUp:
- -performKeyEquivalent:
- -performMnemonic:
- -presentError:
- -presentError:modalForWindow:delegate:didPresentSelector:contextInfo:
- -resignFirstResponder
- -rightMouseDown:
- -rightMouseDragged:
- -rightMouseUp:
- -scrollWheel:
- -setInterfaceStyle:
- -setMenu:
- -setNextResponder:
- -shouldBeTreatedAsInkEvent:
- -tryToPerform:with:
- -undoManager
- -validRequestorForSendType:returnType:
- -willPresentError:

### acceptsFirstResponder

- (BOOL) acceptsFirstResponder;
Availability: OpenStep
Returns `YES` if the receiver is able to become the first responder, `NO` otherwise.

### becomeFirstResponder

- (BOOL) becomeFirstResponder;
Availability: OpenStep
Description forthcoming.

### doCommandBySelector:

- (void) doCommandBySelector: (SEL)aSelector;
Availability: MacOS-X 10.0.0
Description forthcoming.

### encodeWithCoder:

- (void) encodeWithCoder: (NSCoder*)aCoder;
Availability: OpenStep
Description forthcoming.

### flagsChanged:

- (void) flagsChanged: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### flushBufferedKeyEvents

- (void) flushBufferedKeyEvents;
Availability: MacOS-X 10.0.0
Description forthcoming.

### helpRequested:

- (void) helpRequested: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### initWithCoder:

- (id) initWithCoder: (NSCoder*)aDecoder;
Availability: OpenStep
Description forthcoming.

### insertText:

- (void) insertText: (id)aString;
Availability: MacOS-X 10.0.0

Tells the receiver to insert the given string. In a text view the text is typically inserted at the insertion point, and replaces any selection.

Subclasses should override this method. The implementation in NSResponder just sends the message on to the next responder.

Normally, aString will be an NSString, but in some cases, it might be an NSAttributedString.

### interfaceStyle

- (NSInterfaceStyle) interfaceStyle;
Availability: MacOS-X 10.0.0
Description forthcoming.

### interpretKeyEvents:

- (void) interpretKeyEvents: (NSArray*)eventArray;
Availability: MacOS-X 10.0.0
Description forthcoming.

### keyDown:

- (void) keyDown: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### keyUp:

- (void) keyUp: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### menu

- (NSMenu*) menu;
Availability: MacOS-X 10.0.0
Description forthcoming.

### mouseDown:

- (void) mouseDown: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### mouseDragged:

- (void) mouseDragged: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### mouseEntered:

- (void) mouseEntered: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### mouseExited:

- (void) mouseExited: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### mouseMoved:

- (void) mouseMoved: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### mouseUp:

- (void) mouseUp: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### nextResponder

- (NSResponder*) nextResponder;
Availability: OpenStep
Description forthcoming.

### noResponderFor:

- (void) noResponderFor: (SEL)eventSelector;
Availability: OpenStep
Description forthcoming.

### otherMouseDown:

- (void) otherMouseDown: (NSEvent*)theEvent;
Availability: MacOS-X 10.0.0
Description forthcoming.

### otherMouseDragged:

- (void) otherMouseDragged: (NSEvent*)theEvent;
Availability: MacOS-X 10.0.0
Description forthcoming.

### otherMouseUp:

- (void) otherMouseUp: (NSEvent*)theEvent;
Availability: MacOS-X 10.0.0
Description forthcoming.

### performKeyEquivalent:

- (BOOL) performKeyEquivalent: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### performMnemonic:

- (BOOL) performMnemonic: (NSString*)aString;
Availability: MacOS-X 10.0.0
Description forthcoming.

### presentError:

- (BOOL) presentError: (NSError*)error;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### presentError: modalForWindow: delegate: didPresentSelector: contextInfo:

- (void) presentError: (NSError*)error modalForWindow: (NSWindow*)window delegate: (id)delegate didPresentSelector: (SEL)sel contextInfo: (void*)context;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### resignFirstResponder

- (BOOL) resignFirstResponder;
Availability: OpenStep
Description forthcoming.

### rightMouseDown:

- (void) rightMouseDown: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### rightMouseDragged:

- (void) rightMouseDragged: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### rightMouseUp:

- (void) rightMouseUp: (NSEvent*)theEvent;
Availability: OpenStep
Description forthcoming.

### scrollWheel:

- (void) scrollWheel: (NSEvent*)theEvent;
Availability: MacOS-X 10.0.0
Description forthcoming.

### setInterfaceStyle:

- (void) setInterfaceStyle: (NSInterfaceStyle)aStyle;
Availability: MacOS-X 10.0.0
Description forthcoming.

### setMenu:

- (void) setMenu: (NSMenu*)aMenu;
Availability: MacOS-X 10.0.0
Description forthcoming.

### setNextResponder:

- (void) setNextResponder: (NSResponder*)aResponder;
Availability: OpenStep
Description forthcoming.

### shouldBeTreatedAsInkEvent:

- (BOOL) shouldBeTreatedAsInkEvent: (NSEvent*)theEvent;
Availability: MacOS-X 10.0.0
Description forthcoming.

### tryToPerform: with:

- (BOOL) tryToPerform: (SEL)anAction with: (id)anObject;
Availability: OpenStep
If the receiver responds to anAction, it performs that method with anObject as its argument, discards any return value, and return `YES`.
Otherwise, the next responder in the chain is asked to perform anAction and the result of that is returned.
If no responder in the chain is able to respond to anAction, then `NO` is returned.

### undoManager

- (NSUndoManager*) undoManager;
Availability: MacOS-X 10.0.0
Description forthcoming.

### validRequestorForSendType: returnType:

- (id) validRequestorForSendType: (NSString*)typeSent returnType: (NSString*)typeReturned;
Availability: OpenStep
Description forthcoming.

### willPresentError:

- (NSError*) willPresentError: (NSError*)error;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

## Instance Variables for NSResponder Class

### _interface_style

@protected int _interface_style;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _next_responder

@protected NSResponder* _next_responder;
Availability: OpenStep
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

# Software documentation for the NSResponder(OptionalActionMethods) category

## NSResponder(OptionalActionMethods)

> Declared in:
>   AppKit/NSResponder.h

Availability: MacOS-X 10.0.0
Description forthcoming.
Method summary

- -cancelOperation:
- -capitalizeWord:
- -centerSelectionInVisibleArea:
- -changeCaseOfLetter:
- -complete:
- -deleteBackward:
- -deleteBackwardByDecomposingPreviousCharacter:
- -deleteForward:
- -deleteToBeginningOfLine:
- -deleteToBeginningOfParagraph:
- -deleteToEndOfLine:
- -deleteToEndOfParagraph:
- -deleteToMark:
- -deleteWordBackward:
- -deleteWordForward:
- -indent:
- -insertBacktab:
- -insertContainerBreak:
- -insertLineBreak:
- -insertNewline:
- -insertNewlineIgnoringFieldEditor:
- -insertParagraphSeparator:
- -insertTab:
- -insertTabIgnoringFieldEditor:
- -lowercaseWord:
- -moveBackward:
- -moveBackwardAndModifySelection:
- -moveDown:
- -moveDownAndModifySelection:
- -moveForward:
- -moveForwardAndModifySelection:
- -moveLeft:
- -moveLeftAndModifySelection:
- -moveRight:
- -moveRightAndModifySelection:
- -moveToBeginningOfDocument:
- -moveToBeginningOfLine:
- -moveToBeginningOfParagraph:
- -moveToEndOfDocument:
- -moveToEndOfLine:
- -moveToEndOfParagraph:
- -moveUp:
- -moveUpAndModifySelection:
- -moveWordBackward:
- -moveWordBackwardAndModifySelection:
- -moveWordForward:
- -moveWordForwardAndModifySelection:
- -moveWordLeft:
- -moveWordLeftAndModifySelection:
- -moveWordRight:
- -moveWordRightAndModifySelection:
- -pageDown:
- -pageUp:
- -scrollLineDown:
- -scrollLineUp:
- -scrollPageDown:
- -scrollPageUp:
- -selectAll:
- -selectLine:
- -selectParagraph:
- -selectToMark:
- -selectWord:
- -setMark:
- -showContextHelp:
- -swapWithMark:
- -tabletPoint:
- -tabletProximity:
- -transpose:
- -transposeWords:
- -uppercaseWord:
- -yank:

### cancelOperation:

- (void) cancelOperation: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### capitalizeWord:

- (void) capitalizeWord: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### centerSelectionInVisibleArea:

- (void) centerSelectionInVisibleArea: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### changeCaseOfLetter:

- (void) changeCaseOfLetter: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### complete:

- (void) complete: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteBackward:

- (void) deleteBackward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteBackwardByDecomposingPreviousCharacter:

- (void) deleteBackwardByDecomposingPreviousCharacter: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### deleteForward:

- (void) deleteForward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteToBeginningOfLine:

- (void) deleteToBeginningOfLine: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteToBeginningOfParagraph:

- (void) deleteToBeginningOfParagraph: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteToEndOfLine:

- (void) deleteToEndOfLine: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteToEndOfParagraph:

- (void) deleteToEndOfParagraph: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteToMark:

- (void) deleteToMark: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteWordBackward:

- (void) deleteWordBackward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### deleteWordForward:

- (void) deleteWordForward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### indent:

- (void) indent: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertBacktab:

- (void) insertBacktab: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertContainerBreak:

- (void) insertContainerBreak: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### insertLineBreak:

- (void) insertLineBreak: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### insertNewline:

- (void) insertNewline: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertNewlineIgnoringFieldEditor:

- (void) insertNewlineIgnoringFieldEditor: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertParagraphSeparator:

- (void) insertParagraphSeparator: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertTab:

- (void) insertTab: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### insertTabIgnoringFieldEditor:

- (void) insertTabIgnoringFieldEditor: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### lowercaseWord:

- (void) lowercaseWord: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveBackward:

- (void) moveBackward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveBackwardAndModifySelection:

- (void) moveBackwardAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveDown:

- (void) moveDown: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveDownAndModifySelection:

- (void) moveDownAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveForward:

- (void) moveForward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveForwardAndModifySelection:

- (void) moveForwardAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveLeft:

- (void) moveLeft: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveLeftAndModifySelection:

- (void) moveLeftAndModifySelection: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### moveRight:

- (void) moveRight: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveRightAndModifySelection:

- (void) moveRightAndModifySelection: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### moveToBeginningOfDocument:

- (void) moveToBeginningOfDocument: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveToBeginningOfLine:

- (void) moveToBeginningOfLine: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveToBeginningOfParagraph:

- (void) moveToBeginningOfParagraph: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveToEndOfDocument:

- (void) moveToEndOfDocument: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveToEndOfLine:

- (void) moveToEndOfLine: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveToEndOfParagraph:

- (void) moveToEndOfParagraph: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveUp:

- (void) moveUp: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveUpAndModifySelection:

- (void) moveUpAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveWordBackward:

- (void) moveWordBackward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveWordBackwardAndModifySelection:

- (void) moveWordBackwardAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveWordForward:

- (void) moveWordForward: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveWordForwardAndModifySelection:

- (void) moveWordForwardAndModifySelection: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### moveWordLeft:

- (void) moveWordLeft: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### moveWordLeftAndModifySelection:

- (void) moveWordLeftAndModifySelection: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### moveWordRight:

- (void) moveWordRight: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### moveWordRightAndModifySelection:

- (void) moveWordRightAndModifySelection: (id)sender;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### pageDown:

- (void) pageDown: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### pageUp:

- (void) pageUp: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### scrollLineDown:

- (void) scrollLineDown: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### scrollLineUp:

- (void) scrollLineUp: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### scrollPageDown:

- (void) scrollPageDown: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### scrollPageUp:

- (void) scrollPageUp: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### selectAll:

- (void) selectAll: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### selectLine:

- (void) selectLine: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### selectParagraph:

- (void) selectParagraph: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### selectToMark:

- (void) selectToMark: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### selectWord:

- (void) selectWord: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### setMark:

- (void) setMark: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### showContextHelp:

- (void) showContextHelp: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### swapWithMark:

- (void) swapWithMark: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### tabletPoint:

- (void) tabletPoint: (NSEvent*)event;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### tabletProximity:

- (void) tabletProximity: (NSEvent*)event;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### transpose:

- (void) transpose: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### transposeWords:

- (void) transposeWords: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### uppercaseWord:

- (void) uppercaseWord: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

### yank:

- (void) yank: (id)sender;
Availability: MacOS-X 10.0.0
Description forthcoming.

Up