1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright (C) 2008, 2009 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import <Foundation/Foundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
#define WebNSUInteger unsigned int
#else
#define WebNSUInteger NSUInteger
#endif
@class DOMRange;
@class DOMNode;
@class WebTextIteratorPrivate;
@interface WebTextIterator : NSObject {
@private
WebTextIteratorPrivate *_private;
}
- (id)initWithRange:(DOMRange *)range;
/*!
@method advance
@abstract Makes the WebTextIterator iterate to the next visible text element.
*/
- (void)advance;
/*!
@method atEnd
@result YES if the WebTextIterator has reached the end of the DOMRange.
*/
- (BOOL)atEnd;
/*!
@method currentRange
@result A range, indicating the position within the document of the current text.
*/
- (DOMRange *)currentRange;
/*!
@method currentTextPointer
@result A pointer to the current text. The pointer becomes invalid after any modification is made to the document; it must be used right away.
*/
- (const unichar *)currentTextPointer;
/*!
@method currentTextLength
@result lengthPtr Length of the current text.
*/
- (WebNSUInteger)currentTextLength;
@end
@interface WebTextIterator (WebTextIteratorDeprecated)
/*!
@method currentNode
@abstract A convenience method that finds the first node in currentRange; it's almost always better to use currentRange instead.
@result The current DOMNode in the WebTextIterator
*/
- (DOMNode *)currentNode;
/*!
@method currentText
@abstract A convenience method that makes an NSString out of the current text; it's almost always better to use currentTextPointer and currentTextLength instead.
@result The current text in the WebTextIterator.
*/
- (NSString *)currentText;
@end
#undef WebNSUInteger
|
