Up

# NSTextFinder class documentation

### Authors

Generated by root

### Contents -

1. Software documentation for the NSTextFinder class
2. Software documentation for the NSTextFinderBarContainer protocol
3. Software documentation for the NSTextFinderClient protocol

# Software documentation for the NSTextFinder class

## NSTextFinder : NSObject

> Declared in:
>   AppKit/NSTextFinder.h

> Conforms to:
>   NSCoding

Availability: MacOS-X 10.7.0
Description forthcoming.

Instance Variables
Method summary

- +drawIncrementalMatchHighlightInRect:
- -cancelFindIndicator
- -client
- -findBarContainer
- -findIndicatorNeedsUpdate
- -incrementalMatchRanges
- -incrementalSearchingShouldDimContentView
- -isIncrementalSearchingEnabled
- -noteClientStringWillChange
- -performAction:
- -setClient:
- -setFindBarContainer:
- -setFindIndicatorNeedsUpdate:
- -setIncrementalSearchingEnabled:
- -setIncrementalSearchingShouldDimContentView:
- -validateAction:

### drawIncrementalMatchHighlightInRect:

+ (void) drawIncrementalMatchHighlightInRect: (NSRect)rect;
Availability: MacOS-X 10.7.0
Description forthcoming.

### cancelFindIndicator

- (void) cancelFindIndicator;
Availability: MacOS-X 10.7.0
Description forthcoming.

### client

- (id<NSTextFinderClient>) client;
Availability: MacOS-X 10.7.0
Description forthcoming.

### findBarContainer

- (id<NSTextFinderBarContainer>) findBarContainer;
Availability: MacOS-X 10.7.0
Description forthcoming.

### findIndicatorNeedsUpdate

- (BOOL) findIndicatorNeedsUpdate;
Availability: MacOS-X 10.7.0
Description forthcoming.

### incrementalMatchRanges

- (NSArray*) incrementalMatchRanges;
Availability: MacOS-X 10.7.0
Description forthcoming.

### incrementalSearchingShouldDimContentView

- (BOOL) incrementalSearchingShouldDimContentView;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isIncrementalSearchingEnabled

- (BOOL) isIncrementalSearchingEnabled;
Availability: MacOS-X 10.7.0
Description forthcoming.

### noteClientStringWillChange

- (void) noteClientStringWillChange;
Availability: MacOS-X 10.7.0
Description forthcoming.

### performAction:

- (void) performAction: (NSTextFinderAction)op;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setClient:

- (void) setClient: (id<NSTextFinderClient>)client;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setFindBarContainer:

- (void) setFindBarContainer: (id<NSTextFinderBarContainer>)findBarContainer;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setFindIndicatorNeedsUpdate:

- (void) setFindIndicatorNeedsUpdate: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setIncrementalSearchingEnabled:

- (void) setIncrementalSearchingEnabled: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setIncrementalSearchingShouldDimContentView:

- (void) setIncrementalSearchingShouldDimContentView: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### validateAction:

- (BOOL) validateAction: (NSTextFinderAction)op;
Availability: MacOS-X 10.7.0
Description forthcoming.

## Instance Variables for NSTextFinder Class

### _client

@protected id _client;
Availability: MacOS-X 10.7.0
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.

### _findBarContainer

@protected id _findBarContainer;
Availability: MacOS-X 10.7.0
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.

### _findIndicatorNeedsUpdate

@protected BOOL _findIndicatorNeedsUpdate;
Availability: MacOS-X 10.7.0
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.

### _finder

@protected id _finder;
Availability: MacOS-X 10.7.0
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.

### _incrementalMatchRanges

@protected NSArray* _incrementalMatchRanges;
Availability: MacOS-X 10.7.0
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.

### _incrementalSearchingEnabled

@protected BOOL _incrementalSearchingEnabled;
Availability: MacOS-X 10.7.0
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.

### _incrementalSearchingShouldDimContentView

@protected BOOL _incrementalSearchingShouldDimContentView;
Availability: MacOS-X 10.7.0
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.

### _tag

@protected NSInteger _tag;
Availability: MacOS-X 10.7.0
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 NSTextFinderBarContainer protocol

## NSTextFinderBarContainer

> Declared in:
>   AppKit/NSTextFinder.h

> Conforms to:
>   NSObject

Availability: MacOS-X 10.7.0
Description forthcoming.
Method summary

- -contentView
- -findBarView
- -findBarViewDidChangeHeight
- -isfindBarVisible
- -setFindBarView:
- -setFindBarVisible:

### contentView

- (NSView*) contentView;
Availability: MacOS-X 10.7.0
Description forthcoming.

### findBarView

- (NSView*) findBarView;
Availability: MacOS-X 10.7.0
Description forthcoming.

### findBarViewDidChangeHeight

- (void) findBarViewDidChangeHeight;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isfindBarVisible

- (BOOL) isfindBarVisible;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setFindBarView:

- (void) setFindBarView: (NSView*)view;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setFindBarVisible:

- (void) setFindBarVisible: (BOOL)flag;
Availability: MacOS-X 10.7.0
Description forthcoming.

# Software documentation for the NSTextFinderClient protocol

## NSTextFinderClient

> Declared in:
>   AppKit/NSTextFinder.h

> Conforms to:
>   NSObject

Availability: MacOS-X 10.7.0
Description forthcoming.
Method summary

- -allowsMultipleSelection
- -contentViewAtIndex:effectiveCharacterRange:
- -didReplaceCharacters
- -drawCharactersInRange:forContentView:
- -firstSelectedRange
- -isEditable
- -isSelectable
- -rectsForCharacterRange:
- -replaceCharactersInRange:withString:
- -scrollRangeToVisible:
- -selectedRanges
- -setSelectedRanges:
- -shouldReplaceCharactersInRanges:withStrings:
- -string
- -stringAtIndex:effectiveRange:endsWithSearchBoundary:
- -stringLength
- -visibleCharacterRanges

### allowsMultipleSelection

- (BOOL) allowsMultipleSelection;
Availability: MacOS-X 10.7.0
Description forthcoming.

### contentViewAtIndex: effectiveCharacterRange:

- (NSView*) contentViewAtIndex: (NSUInteger)index effectiveCharacterRange: (NSRangePointer)outRange;
Availability: MacOS-X 10.7.0
Description forthcoming.

### didReplaceCharacters

- (void) didReplaceCharacters;
Availability: MacOS-X 10.7.0
Description forthcoming.

### drawCharactersInRange: forContentView:

- (void) drawCharactersInRange: (NSRange)range forContentView: (NSView*)view;
Availability: MacOS-X 10.7.0
Description forthcoming.

### firstSelectedRange

- (NSRange) firstSelectedRange;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isEditable

- (BOOL) isEditable;
Availability: MacOS-X 10.7.0
Description forthcoming.

### isSelectable

- (BOOL) isSelectable;
Availability: MacOS-X 10.7.0
Description forthcoming.

### rectsForCharacterRange:

- (NSArray*) rectsForCharacterRange: (NSRange)range;
Availability: MacOS-X 10.7.0
Description forthcoming.

### replaceCharactersInRange: withString:

- (void) replaceCharactersInRange: (NSRange)range withString: (NSString*)string;
Availability: MacOS-X 10.7.0
Description forthcoming.

### scrollRangeToVisible:

- (void) scrollRangeToVisible: (NSRange)range;
Availability: MacOS-X 10.7.0
Description forthcoming.

### selectedRanges

- (NSArray*) selectedRanges;
Availability: MacOS-X 10.7.0
Description forthcoming.

### setSelectedRanges:

- (void) setSelectedRanges: (NSArray*)ranges;
Availability: MacOS-X 10.7.0
Description forthcoming.

### shouldReplaceCharactersInRanges: withStrings:

- (BOOL) shouldReplaceCharactersInRanges: (NSArray*)ranges withStrings: (NSArray*)strings;
Availability: MacOS-X 10.7.0
Description forthcoming.

### string

- (NSString*) string;
Availability: MacOS-X 10.7.0
Description forthcoming.

### stringAtIndex: effectiveRange: endsWithSearchBoundary:

- (NSString*) stringAtIndex: (NSUInteger)characterIndex effectiveRange: (NSRangePointer)outRange endsWithSearchBoundary: (BOOL*)outFlag;
Availability: MacOS-X 10.7.0
Description forthcoming.

### stringLength

- (NSUInteger) stringLength;
Availability: MacOS-X 10.7.0
Description forthcoming.

### visibleCharacterRanges

- (NSArray*) visibleCharacterRanges;
Availability: MacOS-X 10.7.0
Description forthcoming.

Up