163274bc8bac0e086e3ba22f2e113d4948732c36
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendHost.idl
1 /*
2  * Copyright (C) 2007-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
4  * Copyright (C) 2009 Google Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 [
34     ImplementationLacksVTable,
35     NoInterfaceObject,
36 ] interface InspectorFrontendHost {
37     void loaded();
38     void closeWindow();
39     void reopen();
40     void bringToFront();
41     void inspectedURLChanged(DOMString newURL);
42
43     readonly attribute boolean supportsShowCertificate;
44     boolean showCertificate(DOMString serializedCertificate);
45
46     void setZoomFactor(unrestricted float zoom);
47     float zoomFactor();
48
49     DOMString userInterfaceLayoutDirection();
50
51     void requestSetDockSide(DOMString side);
52
53     void setAttachedWindowHeight(unsigned long height);
54     void setAttachedWindowWidth(unsigned long width);
55
56     void startWindowDrag();
57     void moveWindowBy(unrestricted float x, unrestricted float y);
58
59     DOMString localizedStringsURL();
60     DOMString backendCommandsURL();
61     DOMString debuggableType();
62     unsigned long inspectionLevel();
63
64     void copyText(DOMString text);
65     void killText(DOMString text, boolean shouldPrependToKillRing, boolean shouldStartNewSequence);
66     void openInNewTab(DOMString url);
67     boolean canSave();
68     void save(DOMString url, DOMString content, boolean base64Encoded, boolean forceSaveAs);
69     void append(DOMString url, DOMString content);
70     void close(DOMString url);
71
72     DOMString platform();
73     DOMString port();
74
75     void showContextMenu(Event event, sequence<ContextMenuItem> items);
76     void dispatchEventAsContextMenuEvent(Event event);
77     void sendMessageToBackend(DOMString message);
78     void unbufferedLog(DOMString message);
79
80     boolean isUnderTest();
81
82     void beep();
83     void inspectInspector();
84 };
85
86 dictionary ContextMenuItem {
87     DOMString type;
88     DOMString label;
89     long id;
90     boolean enabled;
91     boolean checked;
92     sequence<ContextMenuItem> subItems;
93 };