Add WebKit2 API to figure out if an input or textarea was edited
[WebKit-https.git] / Source / WebKit2 / WebProcess / InjectedBundle / DOM / InjectedBundleNodeHandle.h
1 /*
2  * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef InjectedBundleNodeHandle_h
27 #define InjectedBundleNodeHandle_h
28
29 #include "APIObject.h"
30 #include <JavaScriptCore/JSBase.h>
31 #include <wtf/Forward.h>
32 #include <wtf/PassRefPtr.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36     class IntRect;
37     class Node;
38 }
39
40 namespace WebKit {
41
42 class InjectedBundleScriptWorld;
43 class WebFrame;
44
45 class InjectedBundleNodeHandle : public APIObject {
46 public:
47     static const Type APIType = TypeBundleNodeHandle;
48
49     static PassRefPtr<InjectedBundleNodeHandle> getOrCreate(JSContextRef, JSObjectRef);
50     static PassRefPtr<InjectedBundleNodeHandle> getOrCreate(WebCore::Node*);
51
52     virtual ~InjectedBundleNodeHandle();
53
54     WebCore::Node* coreNode() const;
55
56     // Convenience DOM Operations
57     PassRefPtr<InjectedBundleNodeHandle> document();
58
59     // Additional DOM Operations
60     // Note: These should only be operations that are not exposed to JavaScript.
61     WebCore::IntRect elementBounds() const;
62     WebCore::IntRect renderRect(bool*) const;
63     void setHTMLInputElementValueForUser(const String&);
64     bool isHTMLInputElementAutofilled() const;
65     void setHTMLInputElementAutofilled(bool);
66     bool htmlInputElementLastChangeWasUserEdit();
67     bool htmlTextAreaElementLastChangeWasUserEdit();
68     
69     PassRefPtr<InjectedBundleNodeHandle> htmlTableCellElementCellAbove();
70
71     PassRefPtr<WebFrame> documentFrame();
72     PassRefPtr<WebFrame> htmlFrameElementContentFrame();
73     PassRefPtr<WebFrame> htmlIFrameElementContentFrame();
74
75 private:
76     static PassRefPtr<InjectedBundleNodeHandle> create(WebCore::Node*);
77     InjectedBundleNodeHandle(WebCore::Node*);
78
79     virtual Type type() const { return APIType; }
80
81     RefPtr<WebCore::Node> m_node;
82 };
83
84 } // namespace WebKit
85
86 #endif // InjectedBundleNodeHandle_h