1/*
2 * Copyright (C) 2005 Apple Computer, 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#import <Foundation/Foundation.h>
30
31#import <WebKit/WebDocumentPrivate.h>
32
33#if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
34#define WebNSUInteger unsigned int
35#else
36#define WebNSUInteger NSUInteger
37#endif
38
39@class WebHTMLRepresentationPrivate;
40@class NSView;
41
42@class DOMNode;
43@class DOMElement;
44
45@protocol WebDocumentMarkup;
46@protocol WebDocumentRepresentation;
47@protocol WebDocumentSourceRepresentation;
48
49/*!
50    @class WebHTMLRepresentation
51*/
52@interface WebHTMLRepresentation : NSObject <WebDocumentRepresentation, WebDocumentDOM>
53{
54    WebHTMLRepresentationPrivate *_private;
55}
56
57+ (NSArray *)supportedMIMETypes;
58+ (NSArray *)supportedNonImageMIMETypes;
59+ (NSArray *)supportedImageMIMETypes;
60+ (NSArray *)unsupportedTextMIMETypes;
61
62- (NSAttributedString *)attributedStringFrom:(DOMNode *)startNode startOffset:(int)startOffset to:(DOMNode *)endNode endOffset:(int)endOffset;
63
64- (DOMElement *)elementWithName:(NSString *)name inForm:(DOMElement *)form;
65- (BOOL)elementDoesAutoComplete:(DOMElement *)element;
66- (BOOL)elementIsPassword:(DOMElement *)element;
67- (DOMElement *)formForElement:(DOMElement *)element;
68- (DOMElement *)currentForm;
69- (NSArray *)controlsInForm:(DOMElement *)form;
70- (NSString *)searchForLabels:(NSArray *)labels beforeElement:(DOMElement *)element resultDistance:(WebNSUInteger*)outDistance resultIsInCellAbove:(BOOL*)outIsInCellAbove;
71- (NSString *)matchLabels:(NSArray *)labels againstElement:(DOMElement *)element;
72
73// Deprecated SPI
74- (NSString *)searchForLabels:(NSArray *)labels beforeElement:(DOMElement *)element; // Use -searchForLabels:beforeElement:resultDistance:resultIsInCellAbove:
75
76@end
77
78#undef WebNSUInteger
79