Mac OS X Reference Library Apple Developer Connection spyglass button

WebDocumentSearching Protocol Reference

Conforms to
Framework
/System/Library/Frameworks/WebKit.framework
Availability
Available in Mac OS X v10.2 with Safari 1.0 and later.
Available in Mac 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. (required)

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

Discussion

This method returns YES if the receiver contains string in the specified direction, NO otherwise. The receiver should select the string if it is found. If directionFlag is YES, the search is in the forward direction from the current location, otherwise the search is in the backward direction. If caseFlag is YES then the search is case sensitive, otherwise it is not. If wrapFlag is YES then the search will continue from the end of the document to the current location, otherwise it stops at the end of the document.

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

Last updated: 2006-05-23

Did this document help you? Yes It's good, but... Not helpful...