Bumping the PLT count back to 5.
[WebKit-https.git] / WebKit / WebInspector / WebInspectorInternal.h
1 /*
2  * Copyright (C) 2006 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 // This header contains WebInspector declarations that can be used anywhere in the Web Kit, but are neither SPI nor API.
30
31 #import <Foundation/NSObject.h>
32 #import <WebKit/WebInspector.h>
33 #import <WebKit/DOMCore.h>
34
35 @class WebView;
36 @class WebFrame;
37 @class DOMHTMLDocument;
38 @class NSOutlineView;
39 @class WebNodeHighlight;
40
41 @interface WebInspectorPrivate : NSObject
42 {
43 @public
44     WebView *webView;
45     DOMHTMLDocument *domDocument;
46     WebFrame *webFrame;
47     DOMNode *rootNode;
48     DOMNode *focusedNode;
49     NSString *searchQuery;
50     NSMutableSet *nodeCache;
51     NSMutableArray *searchResults;
52     NSScrollView *treeScrollView;
53     NSOutlineView *treeOutlineView;
54     WebNodeHighlight *currentHighlight;
55     NSImage *rightArrowImage;
56     NSImage *downArrowImage;
57     BOOL ignoreWhitespace;
58     BOOL webViewLoaded;
59     BOOL searchResultsVisible;
60     BOOL preventHighlight;
61     BOOL preventRevealOnFocus;
62     BOOL preventSelectionRefocus;
63     BOOL isSharedInspector;
64 }
65 @end
66
67 @interface WebInspector (WebInspectorPrivate)
68 - (void)_highlightNode:(DOMNode *)node;
69 - (void)_revealAndSelectNodeInTree:(DOMNode *)node;
70 - (void)_update;
71 - (void)_updateRoot;
72 - (void)_updateSystemColors;
73 - (void)_updateTreeScrollbar;
74 - (void)_updateTraversalButtons;
75 - (void)_refreshSearch;
76 @end
77
78 @interface DOMNode (DOMNodeInspectorAdditions)
79 - (NSString *)_contentPreview;
80
81 - (BOOL)_isAncestorOfNode:(DOMNode *)node;
82 - (BOOL)_isDescendantOfNode:(DOMNode *)node;
83
84 - (BOOL)_isWhitespace;
85
86 - (unsigned long)_lengthOfChildNodesIgnoringWhitespace;
87 - (DOMNode *)_childNodeAtIndexIgnoringWhitespace:(unsigned long)nodeIndex;
88
89 - (DOMNode *)_nextSiblingSkippingWhitespace;
90 - (DOMNode *)_previousSiblingSkippingWhitespace;
91
92 - (DOMNode *)_firstChildSkippingWhitespace;
93 - (DOMNode *)_lastChildSkippingWhitespace;
94
95 - (DOMNode *)_firstAncestorCommonWithNode:(DOMNode *)node;
96
97 - (DOMNode *)_traverseNextNodeStayingWithin:(DOMNode *)stayWithin;
98 - (DOMNode *)_traverseNextNodeSkippingWhitespaceStayingWithin:(DOMNode *)stayWithin;
99 - (DOMNode *)_traversePreviousNode;
100 - (DOMNode *)_traversePreviousNodeSkippingWhitespace;
101
102 - (NSString *)_displayName;
103 @end