42ee95f2cb7ac720b1bccf3eaa0d897d16c684c8
[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 #pragma once
27
28 #include "APIObject.h"
29 #include "ImageOptions.h"
30 #include <JavaScriptCore/JSBase.h>
31 #include <wtf/Forward.h>
32 #include <wtf/RefPtr.h>
33
34 namespace WebCore {
35 class IntRect;
36 class Node;
37 enum class AutoFillButtonType : uint8_t;
38 }
39
40 namespace WebKit {
41
42 class InjectedBundleRangeHandle;
43 class InjectedBundleScriptWorld;
44 class WebFrame;
45 class WebImage;
46
47 class InjectedBundleNodeHandle : public API::ObjectImpl<API::Object::Type::BundleNodeHandle> {
48 public:
49     static RefPtr<InjectedBundleNodeHandle> getOrCreate(JSContextRef, JSObjectRef);
50     static RefPtr<InjectedBundleNodeHandle> getOrCreate(WebCore::Node*);
51     static Ref<InjectedBundleNodeHandle> getOrCreate(WebCore::Node&);
52
53     virtual ~InjectedBundleNodeHandle();
54
55     WebCore::Node* coreNode();
56
57     // Convenience DOM Operations
58     Ref<InjectedBundleNodeHandle> document();
59
60     // Additional DOM Operations
61     // Note: These should only be operations that are not exposed to JavaScript.
62     WebCore::IntRect elementBounds();
63     WebCore::IntRect renderRect(bool*);
64     RefPtr<WebImage> renderedImage(SnapshotOptions, bool shouldExcludeOverflow);
65     RefPtr<InjectedBundleRangeHandle> visibleRange();
66     void setHTMLInputElementValueForUser(const String&);
67     void setHTMLInputElementSpellcheckEnabled(bool);
68     bool isHTMLInputElementAutoFilled() const;
69     void setHTMLInputElementAutoFilled(bool);
70     bool isHTMLInputElementAutoFillButtonEnabled() const;
71     void setHTMLInputElementAutoFillButtonEnabled(WebCore::AutoFillButtonType);
72     WebCore::IntRect htmlInputElementAutoFillButtonBounds();
73     bool htmlInputElementLastChangeWasUserEdit();
74     bool htmlTextAreaElementLastChangeWasUserEdit();
75     bool isTextField() const;
76     
77     RefPtr<InjectedBundleNodeHandle> htmlTableCellElementCellAbove();
78
79     RefPtr<WebFrame> documentFrame();
80     RefPtr<WebFrame> htmlFrameElementContentFrame();
81     RefPtr<WebFrame> htmlIFrameElementContentFrame();
82
83 private:
84     static Ref<InjectedBundleNodeHandle> create(WebCore::Node&);
85     InjectedBundleNodeHandle(WebCore::Node&);
86
87     Ref<WebCore::Node> m_node;
88 };
89
90 } // namespace WebKit