WebCore:
[WebKit-https.git] / WebKit / mac / WebView / WebTextIterator.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import <Foundation/Foundation.h>
27
28
29 @class DOMRange;
30 @class DOMNode;
31 @class WebTextIteratorPrivate;
32
33 @interface WebTextIterator : NSObject
34 {
35 @private
36     WebTextIteratorPrivate *_private;
37 }
38
39 - (id)initWithRange:(DOMRange *)range;
40
41 /*!
42  @method advance:
43  @abstract Makes the WebTextIterator iterate to the next visible text element.
44  */
45 - (void)advance;
46
47 /*!
48  @method currentNode:
49  @result The current DOMNode in the WebTextIterator.
50  */
51 - (DOMNode *)currentNode;
52
53 /*!
54  @method currentText:
55  @result The current text in the WebTextIterator.
56  */
57 - (NSString *)currentText;
58
59 /*!
60  @method atEnd:
61  @result YES if the WebTextIterator has reached the end of the DOMRange.
62  */
63 - (BOOL)atEnd;
64
65
66 @end