d69e6f308fbc355139edfe0426c81688e40e7caf
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebPageProxy.messages.in
1 # Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
5 # are met:
6 # 1.  Redistributions of source code must retain the above copyright
7 #     notice, this list of conditions and the following disclaimer.
8 # 2.  Redistributions in binary form must reproduce the above copyright
9 #     notice, this list of conditions and the following disclaimer in the
10 #     documentation and/or other materials provided with the distribution.
11 #
12 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
13 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR
16 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
18 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
20 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
21 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
23 messages -> WebPageProxy {
24     # UI messages
25     CreateNewPage(WebCore::WindowFeatures windowFeatures, uint32_t modifiers, int32_t mouseButton) -> (uint64_t newPageID, WebKit::WebPageCreationParameters newPageParameters)
26     ShowPage()
27     ClosePage()
28     RunJavaScriptAlert(uint64_t frameID, WTF::String message) -> ()
29     RunJavaScriptConfirm(uint64_t frameID, WTF::String message) -> (bool result)
30     RunJavaScriptPrompt(uint64_t frameID, WTF::String message, WTF::String defaultValue) -> (WTF::String result)
31     MouseDidMoveOverElement(uint32_t modifiers, WebKit::InjectedBundleUserMessageEncoder userData);
32     MissingPluginButtonClicked(WTF::String mimeType, WTF::String url, WTF::String pluginsPageURL)
33     DidChangeViewportData(WebCore::ViewportArguments arguments)
34     DidReceiveEvent(uint32_t type, bool handled)
35     SetCursor(WebCore::Cursor cursor)
36     SetStatusText(WTF::String statusText)
37     SetToolTip(WTF::String toolTip)
38     SetFocus(bool focused)
39     TakeFocus(bool direction)
40     FocusedFrameChanged(uint64_t frameID)
41     FrameSetLargestFrameChanged(uint64_t frameID)
42     SetToolbarsAreVisible(bool toolbarsAreVisible)
43     GetToolbarsAreVisible() -> (bool toolbarsAreVisible)
44     SetMenuBarIsVisible(bool menuBarIsVisible);
45     GetMenuBarIsVisible() -> (bool menuBarIsVisible);
46     SetStatusBarIsVisible(bool statusBarIsVisible)
47     GetStatusBarIsVisible() -> (bool statusBarIsVisible)
48     SetIsResizable(bool isResizable)
49     GetIsResizable() -> (bool isResizable)
50     SetWindowFrame(WebCore::FloatRect windowFrame)
51     GetWindowFrame() -> (WebCore::FloatRect windowFrame)
52     WindowToScreen(WebCore::IntRect rect) -> (WebCore::IntRect screenFrame)
53     RunBeforeUnloadConfirmPanel(WTF::String message, uint64_t frameID) -> (bool shouldClose)
54     PageDidScroll()
55     RunOpenPanel(uint64_t frameID, WebKit::WebOpenPanelParameters::Data parameters)
56     PrintFrame(uint64_t frameID) -> ()
57     RunModal()
58     DidCompleteRubberBandForMainFrame(WebCore::IntSize initialOverhang)
59     DidChangeScrollbarsForMainFrame(bool hasHorizontalScrollbar, bool hasVerticalScrollbar)
60     DidChangeScrollOffsetPinningForMainFrame(bool hasHorizontalScrollbar, bool hasVerticalScrollbar)
61
62 #if ENABLE(TILED_BACKING_STORE)
63     PageDidRequestScroll(WebCore::IntPoint point)
64 #endif
65 #if PLATFORM(QT)
66     DidChangeContentsSize(WebCore::IntSize newSize)
67     DidFindZoomableArea(WebCore::IntRect area)
68 #endif
69
70     # Policy messages
71     DecidePolicyForResponse(uint64_t frameID, WebCore::ResourceResponse response, WebCore::ResourceRequest request, uint64_t listenerID, WebKit::InjectedBundleUserMessageEncoder userData) -> (bool receivedPolicyAction, uint64_t policyAction, uint64_t downloadID)
72     DecidePolicyForNavigationAction(uint64_t frameID, uint32_t navigationType, uint32_t modifiers, int32_t mouseButton, WebCore::ResourceRequest request, uint64_t listenerID, WebKit::InjectedBundleUserMessageEncoder userData) -> (bool receivedPolicyAction, uint64_t policyAction, uint64_t downloadID)
73     DecidePolicyForNewWindowAction(uint64_t frameID, uint32_t navigationType, uint32_t modifiers, int32_t mouseButton, WebCore::ResourceRequest request, WTF::String frameName, uint64_t listenerID, WebKit::InjectedBundleUserMessageEncoder userData)
74     UnableToImplementPolicy(uint64_t frameID, WebCore::ResourceError error, WebKit::InjectedBundleUserMessageEncoder userData)
75
76     # Progress messages
77     DidChangeProgress(double value)
78     DidFinishProgress()
79     DidStartProgress()
80
81     # Frame lifetime messages
82     DidCreateMainFrame(uint64_t frameID)
83     DidCreateSubframe(uint64_t frameID, uint64_t parentFrameID)
84     DidSaveFrameToPageCache(uint64_t frameID);
85     DidRestoreFrameFromPageCache(uint64_t frameID, uint64_t parentFrameID);
86
87     # Frame load messages
88     DidCommitLoadForFrame(uint64_t frameID, WTF::String mimeType, bool hasCustomRepresentation, WebKit::PlatformCertificateInfo certificateInfo, WebKit::InjectedBundleUserMessageEncoder userData)
89     DidFailLoadForFrame(uint64_t frameID, WebCore::ResourceError error, WebKit::InjectedBundleUserMessageEncoder userData)
90     DidFailProvisionalLoadForFrame(uint64_t frameID, WebCore::ResourceError error, WebKit::InjectedBundleUserMessageEncoder userData)
91     DidFinishDocumentLoadForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
92     DidFinishLoadForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
93     DidFirstLayoutForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
94     DidFirstVisuallyNonEmptyLayoutForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
95     DidReceiveServerRedirectForProvisionalLoadForFrame(uint64_t frameID, WTF::String url, WebKit::InjectedBundleUserMessageEncoder userData)
96     DidRemoveFrameFromHierarchy(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
97     DidStartProvisionalLoadForFrame(uint64_t frameID, WTF::String url, WTF::String unreachableURL, WebKit::InjectedBundleUserMessageEncoder userData)
98     DidReceiveTitleForFrame(uint64_t frameID, WTF::String title, WebKit::InjectedBundleUserMessageEncoder userData)
99     DidDisplayInsecureContentForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
100     DidRunInsecureContentForFrame(uint64_t frameID, WebKit::InjectedBundleUserMessageEncoder userData)
101     DidSameDocumentNavigationForFrame(uint64_t frameID, uint32_t type, WTF::String url, WebKit::InjectedBundleUserMessageEncoder userData)
102
103     FrameDidBecomeFrameSet(uint64_t frameID, bool value)
104
105     # Resource load messages
106     DidInitiateLoadForResource(uint64_t frameID, uint64_t resourceIdentifier, WebCore::ResourceRequest request, bool pageIsProvisionallyLoading)
107     DidSendRequestForResource(uint64_t frameID, uint64_t resourceIdentifier, WebCore::ResourceRequest request, WebCore::ResourceResponse redirectResponse)
108     DidReceiveResponseForResource(uint64_t frameID, uint64_t resourceIdentifier, WebCore::ResourceResponse response)
109     DidReceiveContentLengthForResource(uint64_t frameID, uint64_t resourceIdentifier, uint64_t contentLength)
110     DidFinishLoadForResource(uint64_t frameID, uint64_t resourceIdentifier)
111     DidFailLoadForResource(uint64_t frameID, uint64_t resourceIdentifier, WebCore::ResourceError error)
112
113     # Custom representations
114     DidFinishLoadingDataForCustomRepresentation(WTF::String suggestedFilename, CoreIPC::DataReference data)
115
116     # Forms messages
117     WillSubmitForm(uint64_t frameID, uint64_t sourceFrameID, WebKit::StringPairVector textFieldValues, uint64_t listenerID, WebKit::InjectedBundleUserMessageEncoder userData)
118
119     # Callback messages
120     VoidCallback(uint64_t callbackID)
121     DataCallback(CoreIPC::DataReference resultData, uint64_t callbackID)
122     StringCallback(WTF::String resultString, uint64_t callbackID)
123     ScriptValueCallback(CoreIPC::DataReference resultData, uint64_t callbackID)
124     ComputedPagesCallback(Vector<WebCore::IntRect> pageRects, double totalScaleFactorForPrinting, uint64_t callbackID)
125     ValidateCommandCallback(WTF::String command, bool isEnabled, int32_t state, uint64_t callbackID)
126
127     ViewScaleFactorDidChange(double scaleFactor)
128
129 #if PLATFORM(GTK)
130     # Support for GTK+ platform keybindings
131     GetEditorCommandsForKeyEvent() -> (Vector<WTF::String> commandsList)
132 #endif
133
134     # BackForward messages
135     BackForwardAddItem(uint64_t itemID)
136     BackForwardGoToItem(uint64_t itemID)
137     BackForwardItemAtIndex(int32_t itemIndex) -> (uint64_t itemID)
138     BackForwardBackListCount() -> (int32_t count)
139     BackForwardForwardListCount() -> (int32_t count)
140     BackForwardClear()
141     ShouldGoToBackForwardListItem(uint64_t itemID) -> (bool shouldGoToBackForwardListItem)
142
143     # Undo/Redo messages
144     RegisterEditCommandForUndo(uint64_t commandID, uint32_t editAction)
145     ClearAllEditCommands()
146     CanUndoRedo(uint32_t action) -> (bool result)
147     ExecuteUndoRedo(uint32_t action) -> (bool result)
148     
149     # Selection messages
150     SelectionStateChanged(WebKit::SelectionState selectionState)
151 #if PLATFORM(WIN)
152     DidChangeCompositionSelection(bool hasChanged)
153 #endif
154
155     # Find messages
156     DidCountStringMatches(WTF::String string, uint32_t matchCount)
157     SetFindIndicator(WebCore::FloatRect selectionRect, Vector<WebCore::FloatRect> textRects, WebKit::ShareableBitmap::Handle contentImageHandle, bool fadeOut)
158     DidFindString(WTF::String string, uint32_t matchCount)
159     DidFailToFindString(WTF::String string)
160
161     # PopupMenu messages
162     ShowPopupMenu(WebCore::IntRect rect, uint64_t textDirection, Vector<WebKit::WebPopupItem> items, int32_t selectedIndex, WebKit::PlatformPopupMenuData data)
163     HidePopupMenu()
164 #if PLATFORM(WIN)
165     SetPopupMenuSelectedIndex(int32_t selectedIndex)
166 #endif
167
168     # ContextMenu messages
169     ShowContextMenu(WebCore::IntPoint menuLocation, WebKit::ContextMenuState state, Vector<WebKit::WebContextMenuItemData> items, WebKit::InjectedBundleUserMessageEncoder userData)
170
171     # Authentication messages
172     CanAuthenticateAgainstProtectionSpaceInFrame(uint64_t frameID, WebCore::ProtectionSpace protectionSpace) -> (bool canAuthenticate)
173     DidReceiveAuthenticationChallenge(uint64_t frameID, WebCore::AuthenticationChallenge challenge, uint64_t challengeID)
174
175     # Database messages
176     ExceededDatabaseQuota(uint64_t frameID, WTF::String originIdentifier, WTF::String databaseName, WTF::String databaseDisplayName, uint64_t currentQuota, uint64_t currentUsage, uint64_t expectedUsage) -> (uint64_t newQuota)
177
178     # Geolocation messages
179     RequestGeolocationPermissionForFrame(uint64_t geolocationID, uint64_t frameID, WTF::String originIdentifier)
180
181     # Spelling and grammar messages
182 #if USE(UNIFIED_TEXT_CHECKING)  
183     CheckTextOfParagraph(WTF::String text, uint64_t checkingTypes) -> (Vector<WebCore::TextCheckingResult> results)
184 #endif
185     CheckSpellingOfString(WTF::String text) -> (int32_t misspellingLocation, int32_t misspellingLength)
186     CheckGrammarOfString(WTF::String text) -> (Vector<WebCore::GrammarDetail> results, int32_t badGrammarLocation, int32_t badGrammarLength)
187     UpdateSpellingUIWithMisspelledWord(WTF::String misspelledWord)
188     UpdateSpellingUIWithGrammarString(WTF::String badGrammarPhrase, WebCore::GrammarDetail grammarDetail)
189     GetGuessesForWord(WTF::String word, WTF::String context) -> (Vector<WTF::String> guesses)
190     LearnWord(WTF::String word);
191     IgnoreWord(WTF::String word);
192
193     # Drag and drop messages
194     DidPerformDragControllerAction(uint64_t resultOperation)
195 #if PLATFORM(MAC)
196     SetDragImage(WebCore::IntPoint clientPosition, WebKit::ShareableBitmap::Handle dragImage, bool linkDrag)
197 #endif
198 #if PLATFORM(WIN)
199     StartDragDrop(WebCore::IntPoint imagePoint, WebCore::IntPoint dragPoint, uint64_t okEffect, HashMap<UINT,Vector<String> > dataMap, WebCore::IntSize dragImageSize, WebKit::SharedMemory::Handle dragImage, bool linkDrag)
200 #endif
201
202 #if PLATFORM(MAC)
203     # Dictionary support.
204     DidPerformDictionaryLookup(WTF::String text, WebKit::DictionaryPopupInfo dictionaryPopupInfo)
205
206     # Keyboard input support messages
207     InterpretQueuedKeyEvent(WebKit::TextInputState state) -> (bool handled, Vector<WebCore::KeypressCommand> savedCommands)
208     ExecuteSavedCommandBySelector(WTF::String selector) -> (bool handled)
209
210     # Remote accessibility messages
211     RegisterWebProcessAccessibilityToken(CoreIPC::DataReference data)
212
213     # Plug-in complex text input support messages
214     SetComplexTextInputEnabled(uint64_t pluginComplexTextInputIdentifier, bool complexTextInputEnabled)
215
216     # Speech messages
217     GetIsSpeaking() -> (bool isSpeaking)
218     Speak(WTF::String string)
219     StopSpeaking()
220
221     # Spotlight
222     SearchWithSpotlight(WTF::String string)
223 #endif
224
225 #if PLATFORM(MAC) && !defined(BUILDING_ON_SNOW_LEOPARD)
226     # Autocorrection messages
227     ShowCorrectionPanel(int32_t panelType, WebCore::FloatRect boundingBoxOfReplacedString, String replacedString, String replacementString, Vector<String> alternativeReplacementStrings)
228     DismissCorrectionPanel(int32_t reason)
229     DismissCorrectionPanelSoon(int32_t reason) -> (String result)
230     RecordAutocorrectionResponse(int32_t responseType, String replacedString, String replacementString);
231 #endif
232 }