WebDocumentSearching Protocol Reference

Conforms to
Framework
/System/Library/Frameworks/WebKit.framework
Availability
Available in OS X v10.2 with Safari 1.0 and later.
Available in OS X v10.2.7 and later.
Companion guide
Declared in
WebDocument.h

Overview

WebDocumentSearching is an optional protocol for document view objects that support searching. Classes that adopt this protocol should also adopt WebDocumentView and inherit from NSView.

Tasks

Searching a Document

Instance Methods

searchFor:direction:caseSensitive:wrap:

Searches for a string in a given direction from the current position.

- (BOOL)searchFor:(NSString *)string direction:(BOOL)directionFlag caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag
Parameters
string

The string to search for.

directionFlag

If YES, the search is in the forward direction from the current location; otherwise, the search is in the backward direction.

caseFlag

If YES then the search is case sensitive; otherwise, it is not.

wrapFlag

If YES, the search continues from the end of the document to the current location; otherwise, it stops at the end of the document.

Return Value

YES if the receiver contains string in the specified direction; otherwise, NO.

Discussion

The receiver should select the string if it is found.

Availability
  • Available in OS X v10.2 with Safari 1.0 and later.
  • Available in OS X v10.2.7 and later.
Declared In
WebDocument.h