SearchResult Class Reference

#import <SearchResult.h>

Inheritance diagram for SearchResult:

Properties
NSString *	text
NSString *	nodeName
NSString *	chapterTitle
int	uniqueIndex
int	startOffset
int	endOffset
int	chapterIndex
int	pageIndex
int	numberOfSearched
int	numberOfSearchedInChapter
int	numberOfPagesInChapter
int	numberOfChaptersInBook
double	pagePositionInChapter
double	pagePositionInBook

Detailed Description

SearchResult class contains the information about the searched text.

Property Documentation

- (int) chapterIndex

readwriteatomicprotected

the index of chapter where the searched key is found in.

- (NSString *) chapterTitle

readwritenonatomicretain

the title of chapter.

- (int) endOffset

readwriteatomicprotected

the end offset in the text which contains the searched key.

- (NSString *) nodeName

readwritenonatomicretain

the name of html node that contains the searched key.

- (int) numberOfChaptersInBook

readwriteatomicprotected

the number of Chapters in book

- (int) numberOfPagesInChapter

readwriteatomicprotected

the number of Pages in the chapter

- (int) numberOfSearched

readwriteatomicprotected

the accumulated number of the searched items.

- (int) numberOfSearchedInChapter

readwriteatomicprotected

the accumulated number of the searched texts in this chapter.

- (int) pageIndex

readwriteatomicprotected

the index of the page where the searched key is found in.

- (double) pagePositionInBook

readwriteatomicprotected

the global position from the beginning of the book.

- (double) pagePositionInChapter

readwriteatomic

the position from the start of chapter.

- (int) startOffset

readwriteatomicprotected

the start offset in the text which contains the searched key.

- (NSString *) text

readwritenonatomicretain

the text containing the searched key.

- (int) uniqueIndex

readwriteatomic

the index of the element that contains the searched key.

---

The documentation for this class was generated from the following file:

• SearchResult.h