| blob | d83b077dde887ed785df5bfd98f976ae48a34c5e |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // IPC messages for page rendering.
6 // Multiply-included message file, hence no include guard.
60 #if defined(OS_MACOSX)
62 #endif
64 #undef IPC_MESSAGE_EXPORT
65 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
67 #define IPC_MESSAGE_START ViewMsgStart
92 #if defined(OS_MACOSX)
97 #endif
175 #if defined(OS_MACOSX)
186 #if defined(OS_ANDROID)
189 #endif
213 #if defined(OS_ANDROID)
215 #endif
304 // Routing ID of the view initiating the open.
307 // True if this open request came in the context of a user gesture.
310 // Type of window requested.
313 // The session storage namespace ID this view should use.
316 // The name of the resulting frame that should be created (empty if none
317 // has been specified).
320 // The frame identifier of the frame initiating the open.
323 // The URL of the frame initiating the open.
326 // The security origin of the frame initiating the open.
329 // Whether the opener will be suppressed in the new window, in which case
330 // scripting the new window is not allowed.
333 // Whether the window should be opened in the foreground, background, etc.
336 // The URL that will be loaded in the new window (empty if none has been
337 // sepcified).
342 // URL for the worker script.
345 // Name for a SharedWorker, otherwise empty string.
348 // The ID of the parent document (unique within parent renderer).
351 // RenderView routing id used to send messages back to the parent.
354 // The route ID to associate with the worker. If MSG_ROUTING_NONE is passed,
355 // a new unique ID is created and assigned to the worker.
358 // The ID of the appcache the main shared worker script resource was loaded
359 // from, only valid for shared workers.
374 // The frame ID for the failure report.
376 // True if this is the top-most frame.
378 // Error code as reported in the DidFailProvisionalLoad callback.
380 // An error message generated from the error_code. This can be an empty
381 // string if we were unable to find a meaningful description.
383 // The URL that the error is reported for.
385 // True if the failure is the result of navigating to a POST again
386 // and we're going to show the POST interstitial.
390 // Parameters structure for ViewHostMsg_FrameNavigate, which has too many data
391 // parameters to be reasonably put in a predefined IPC message.
395 // The frame ID for this navigation. The frame ID uniquely identifies the
396 // frame the navigation happened in for a given renderer.
399 // Information regarding the security of the connection (empty if the
400 // connection was not secure).
403 // The gesture that initiated this navigation.
406 // True if this was a post request.
409 // The POST body identifier. -1 if it doesn't exist.
412 // Whether the frame navigation resulted in no change to the documents within
413 // the page. For example, the navigation may have just resulted in scrolling
414 // to a named anchor.
417 // The status code of the HTTP request.
420 // True if the connection was proxied. In this case, socket_address
421 // will represent the address of the proxy, rather than the remote host.
424 // Serialized history item state to store in the navigation entry.
427 // Original request's URL.
430 // User agent override used to navigate.
450 // This message is used for supporting popup menus on Mac OS X using native
451 // Cocoa controls. The renderer sends us this message which we use to populate
452 // the popup menu.
454 // Position on the screen.
457 // The height of each item in the menu.
460 // The size of the font to use for those items.
463 // The currently selected (displayed) item in the menu.
466 // The entire list of items in the popup menu.
469 // Whether items should be right-aligned.
472 // Whether this is a multi-select popup.
477 // The type of input field
480 // The value of the input field
483 // The cursor position of the current selection start, or the caret position
484 // if nothing is selected
487 // The cursor position of the current selection end, or the caret position
488 // if nothing is selected
491 // The start position of the current composition, or -1 if there is none
494 // The end position of the current composition, or -1 if there is none
497 // Whether or not inline composition can be performed for the current input.
500 // Whether or not the IME should be shown as a result of this update. Even if
501 // true, the IME will only be shown if the type is appropriate (e.g. not
502 // TEXT_INPUT_TYPE_NONE).
507 // The bitmap to be painted into the view at the locations specified by
508 // update_rects.
511 // The position and size of the bitmap.
514 // The scroll delta. Only one of the delta components can be non-zero, and if
515 // they are both zero, then it means there is no scrolling and the scroll_rect
516 // is ignored.
519 // The rectangular region to scroll.
522 // The scroll offset of the render view.
525 // The regions of the bitmap (in view coords) that contain updated pixels.
526 // In the case of scrolling, this includes the scroll damage rect.
529 // The size of the RenderView when this message was generated. This is
530 // included so the host knows how large the view is from the perspective of
531 // the renderer process. This is necessary in case a resize operation is in
532 // progress. If auto-resize is enabled, this should update the corresponding
533 // view size.
536 // New window locations for plugin child windows.
538 plugin_window_moves)
540 // The following describes the various bits that may be set in flags:
541 //
542 // ViewHostMsg_UpdateRect_Flags::IS_RESIZE_ACK
543 // Indicates that this is a response to a ViewMsg_Resize message.
544 //
545 // ViewHostMsg_UpdateRect_Flags::IS_RESTORE_ACK
546 // Indicates that this is a response to a ViewMsg_WasShown message.
547 //
548 // ViewHostMsg_UpdateRect_Flags::IS_REPAINT_ACK
549 // Indicates that this is a response to a ViewMsg_Repaint message.
550 //
551 // If flags is zero, then this message corresponds to an unsolicited paint
552 // request by the render view. Any of the above bits may be set in flags,
553 // which would indicate that this paint message is an ACK for multiple
554 // request messages.
557 // Whether or not the renderer expects a ViewMsg_UpdateRect_ACK for this
558 // update. True for 2D painting, but false for accelerated compositing.
561 // All the above coordinates are in DIP. This is the scale factor needed
562 // to convert them to pixels.
567 // The page_id for this navigation, or -1 if it is a new navigation. Back,
568 // Forward, and Reload navigations should have a valid page_id. If the load
569 // succeeds, then this page_id will be reflected in the resultant
570 // ViewHostMsg_FrameNavigate message.
573 // If page_id is -1, then pending_history_list_offset will also be -1.
574 // Otherwise, it contains the offset into the history list corresponding to
575 // the current navigation.
578 // Informs the RenderView of where its current page contents reside in
579 // session history and the total size of the session history list.
583 // The URL to load.
586 // Base URL for use in WebKit's SubstituteData.
587 // Is only used with data: URLs.
590 // History URL for use in WebKit's SubstituteData.
591 // Is only used with data: URLs.
594 // The URL to send in the "Referer" header field. Can be empty if there is
595 // no referrer.
598 // The type of transition.
601 // Opaque history state (received by ViewHostMsg_UpdateState).
604 // Type of navigation.
607 // The time the request was created
610 // Extra headers (separated by \n) to send during the request.
613 // The following two members identify a previous request that has been
614 // created before this navigation is being transferred to a new render view.
615 // This serves the purpose of recycling the old request.
616 // Unless this refers to a transferred navigation, these values are -1 and -1.
620 // Whether or not we should allow the url to download.
623 // Whether or not the user agent override string should be used.
626 // True if this was a post request.
629 // If is_post is true, holds the post_data information from browser. Empty
630 // otherwise.
633 // Whether or not this url should be allowed to access local file://
634 // resources.
637 // If not empty, which frame to navigate.
640 // The navigationStart time to expose to JS for this navigation.
645 // Renderer-wide preferences.
648 // Preferences for this view.
651 // The ID of the view to be created.
654 // The ID of the rendering surface.
657 // The session storage namespace ID this view should use.
660 // The name of the frame associated with this view (or empty if none).
663 // The route ID of the opener RenderView if we need to set one
664 // (MSG_ROUTING_NONE otherwise).
667 // Whether the RenderView should initially be swapped out.
670 // The initial page ID to use for this view, which must be larger than any
671 // existing navigation that might be loaded in the view. Page IDs are unique
672 // to a view and are only updated by the renderer after this initial value.
675 // The properties of the screen associated with the view.
678 // The accessibility mode of the renderer.
681 // Specifies whether partially swapping composited buffers is
682 // allowed for a renderer. Partial swaps will be used if they are both
683 // allowed and supported.
688 // The serialized script value.
691 // When sent to the browser, this is the routing ID of the source frame in
692 // the source process. The browser replaces it with the routing ID of the
693 // equivalent (swapped out) frame in the destination process.
695 // The identifier of the source frame in the source process.
698 // The full set of identifiers to uniquely describe the target frame. See
699 // the comment on ViewMsg_FrameTreeUpdated for details.
704 // The origin of the source frame.
707 // The origin for the message's target.
712 // The identifier of the RenderProcessHost for the currently closing view.
713 //
714 // These first two parameters are technically redundant since they are
715 // needed only when processing the ACK message, and the processor
716 // theoretically knows both the process and route ID. However, this is
717 // difficult to figure out with our current implementation, so this
718 // information is duplicated here.
721 // The route identifier for the currently closing RenderView.
724 // The identifier of the RenderProcessHost for the new view attempting to
725 // replace the closing one above.
728 // The identifier of the *request* the new view made that is causing the
729 // cross-site transition. This is *not* a route_id, but the request that we
730 // will resume once the ACK from the closing view has been received.
734 // Messages sent from the browser to the renderer.
736 // Tells the renderer to cancel an opened date/time dialog.
739 // Get all savable resource links from current webpage, include main
740 // frame and sub-frame.
744 // Get html data by serializing all frames of current page with lists
745 // which contain all resource links that have local copy.
751 // Tells the render side that a ViewHostMsg_LockMouse message has been
752 // processed. |succeeded| indicates whether the mouse has been successfully
753 // locked or not.
756 // Tells the render side that the mouse has been unlocked.
759 // Screen was rotated. Dispatched to the onorientationchange javascript API.
763 // Sent by the renderer when the parameters for vsync alignment have changed.
768 // Set the top-level frame to the provided name.
772 // Sent to the RenderView when a new tab is swapped into an existing
773 // tab and the histories need to be merged. The existing tab has a history of
774 // |merged_history_length| which precedes the history of the new tab. All
775 // page_ids >= |minimum_page_id| in the new tab are appended to the history.
776 //
777 // For example, suppose the history of page_ids in the new tab's RenderView
778 // is [4 7 8]. This is merged into an existing tab with 3 history items, and
779 // all pages in the new tab with page_id >= 7 are to be preserved.
780 // The resulting page history is [-1 -1 -1 7 8].
785 // Tells the renderer to create a new view.
786 // This message is slightly different, the view it takes (via
787 // ViewMsg_New_Params) is the view to create, the message itself is sent as a
788 // non-view control message.
790 ViewMsg_New_Params)
792 // Reply in response to ViewHostMsg_ShowView or ViewHostMsg_ShowWidget.
793 // similar to the new command, but used when the renderer created a view
794 // first, and we need to update it.
797 // Sends updated preferences to the renderer.
801 // This passes a set of webkit preferences down to the renderer.
805 // Informs the renderer that the timezone has changed.
808 // Tells the render view to close.
811 // Tells the render view to change its size. A ViewHostMsg_PaintRect message
812 // is generated in response provided new_size is not empty and not equal to
813 // the view's current size. The generated ViewHostMsg_PaintRect message will
814 // have the IS_RESIZE_ACK flag set. It also receives the resizer rect so that
815 // we don't have to fetch it every time WebKit asks for it.
823 // Tells the render view that the resize rect has changed.
827 // Sent to inform the view that it was hidden. This allows it to reduce its
828 // resource utilization.
831 // Tells the render view that it is no longer hidden (see WasHidden), and the
832 // render view is expected to respond with a full repaint if needs_repainting
833 // is true. In that case, the generated ViewHostMsg_PaintRect message will
834 // have the IS_RESTORE_ACK flag set. If needs_repainting is false, then this
835 // message does not trigger a message in response.
839 // Sent to inform the view that it was swapped out. This allows the process to
840 // exit if no other views are using it.
843 // Sent to render the view into the supplied transport DIB, resize
844 // the web widget to match the |page_size|, scale it by the
845 // appropriate scale to make it fit the |desired_size|, and return
846 // it. In response to this message, the host generates a
847 // ViewHostMsg_PaintAtSize_ACK message. Note that the DIB *must* be
848 // the right size to receive an RGBA image at the |desired_size|.
849 // |tag| is sent along with ViewHostMsg_PaintAtSize_ACK unmodified to
850 // identify the PaintAtSize message the ACK belongs to.
857 // Tells the render view that a ViewHostMsg_UpdateRect message was processed.
858 // This signals the render view that it can send another UpdateRect message.
861 // Tells the render view that a SwapBuffers was completed. Typically,
862 // SwapBuffers requests go from renderer -> GPU process -> browser. Most
863 // platforms still use the GfxCxt3D Echo for receiving the SwapBuffers Ack.
864 // Using Echo routes the ack from browser -> GPU process -> renderer, while this
865 // Ack goes directly from browser -> renderer. This is not used for the threaded
866 // compositor path.
869 // Sends an input event to the render widget.
874 // Tells the render widget that a smooth scroll completed.
878 // This message notifies the renderer that the next key event is bound to one
879 // or more pre-defined edit commands. If the next key event is not handled
880 // by webkit, the specified edit commands shall be executed against current
881 // focused frame.
882 // Parameters
883 // * edit_commands (see chrome/common/edit_command_types.h)
884 // Contains one or more edit commands.
885 // See third_party/WebKit/Source/WebCore/editing/EditorCommand.cpp for detailed
886 // definition of webkit edit commands.
887 //
888 // This message must be sent just before sending a key event.
892 // Message payload is the name/value of a WebCore edit command to execute.
899 // TODO(darin): figure out how this meshes with RestoreFocus
903 // Tells the renderer to focus the first (last if reverse is true) focusable
904 // node.
908 // Tells the renderer to scroll the currently focused node into rect only if
909 // the currently focused node is a Text node (textfield, text area or content
910 // editable divs).
913 // Executes custom context menu action that was provided from WebKit.
918 // Sent in response to a ViewHostMsg_ContextMenu to let the renderer know that
919 // the menu has been closed.
923 // Tells the renderer to perform the specified navigation, interrupting any
924 // existing navigation.
929 // Tells the renderer to reload the current focused frame
932 // Sent when the user wants to search for a word on the page (find in page).
938 // This message notifies the renderer that the user has closed the FindInPage
939 // window (and what action to take regarding the selection).
943 // These messages are typically generated from context menus and request the
944 // renderer to apply the specified operation to the current selection.
949 #if defined(OS_MACOSX)
951 #endif
954 // Replaces the selected region or a word around the cursor with the
955 // specified string.
957 string16)
958 // Replaces the misspelling in the selected region with the specified string.
960 string16)
964 // Replaces a date time input field.
970 // Requests the renderer to select the region between two points.
971 // Expects a SelectRange_ACK message when finished.
976 // Requests the renderer to move the caret selection toward the point.
977 // Expects a MoveCaret_ACK message when finished.
981 // Copies the image at location x, y to the clipboard (if there indeed is an
982 // image at that location).
987 // Tells the renderer to perform the given action on the media player
988 // located at the given point.
993 // Tells the renderer to perform the given action on the plugin located at
994 // the given point.
999 // Request for the renderer to evaluate an xpath to a frame and execute a
1000 // javascript: url in that frame's context. The message is completely
1001 // asynchronous and no corresponding response message is sent back.
1002 //
1003 // frame_xpath contains the modified xpath notation to identify an inner
1004 // subframe (starting from the root frame). It is a concatenation of
1005 // number of smaller xpaths delimited by '\n'. Each chunk in the string can
1006 // be evaluated to a frame in its parent-frame's context.
1007 //
1008 // Example: /html/body/iframe/\n/html/body/div/iframe/\n/frameset/frame[0]
1009 // can be broken into 3 xpaths
1010 // /html/body/iframe evaluates to an iframe within the root frame
1011 // /html/body/div/iframe evaluates to an iframe within the level-1 iframe
1012 // /frameset/frame[0] evaluates to first frame within the level-2 iframe
1013 //
1014 // jscript_url is the string containing the javascript: url to be executed
1015 // in the target frame's context. The string should start with "javascript:"
1016 // and continue with a valid JS text.
1017 //
1018 // If the fourth parameter is true the result is sent back to the renderer
1019 // using the message ViewHostMsg_ScriptEvalResponse.
1020 // ViewHostMsg_ScriptEvalResponse is passed the ID parameter so that the
1021 // client can uniquely identify the request.
1028 // Posts a message from a frame in another process to the current renderer.
1030 ViewMsg_PostMessage_Params)
1032 // Requests that the RenderView's main frame sets its opener to null.
1035 // Sends a JSON serialized frame tree to RenderView along with the process id
1036 // and route id of the source renderer.
1037 //
1038 // This message must be sent to swapped out RenderViews every time the browser
1039 // receives a ViewHostMsg_FrameTreeUpdated message.
1045 // Request for the renderer to evaluate an xpath to a frame and insert css
1046 // into that frame's document. See ViewMsg_ScriptEvalRequest for details on
1047 // allowed xpath expressions.
1052 // Change the zoom level for the current main frame. If the level actually
1053 // changes, a ViewHostMsg_DidZoomURL message will be sent back to the browser
1054 // telling it what url got zoomed and what its current zoom level is.
1058 // Set the zoom level for the current main frame. If the level actually
1059 // changes, a ViewHostMsg_DidZoomURL message will be sent back to the browser
1060 // telling it what url got zoomed and what its current zoom level is.
1064 // Zooms the page by the factor defined in the renderer.
1070 // Set the zoom level for a particular url that the renderer is in the
1071 // process of loading. This will be stored, to be used if the load commits
1072 // and ignored otherwise.
1077 // Set the zoom level for a particular url, so all render views
1078 // displaying this url can update their zoom levels to match.
1079 // If scheme is empty, then only host is used for matching.
1085 // Change encoding of page in the renderer.
1089 // Reset encoding of page in the renderer back to default.
1092 // Used to tell a render view whether it should expose various bindings
1093 // that allow JS content extended privileges. See BindingsPolicy for valid
1094 // flag values.
1098 // Tell the renderer to add a property to the WebUI binding object. This
1099 // only works if we allowed WebUI bindings.
1104 // This message starts/stop monitoring the input method status of the focused
1105 // edit control of a renderer process.
1106 // Parameters
1107 // * is_active (bool)
1108 // Indicates if an input method is active in the browser process.
1109 // The possible actions when a renderer process receives this message are
1110 // listed below:
1111 // Value Action
1112 // true Start sending IPC message ViewHostMsg_ImeUpdateTextInputState
1113 // to notify the input method status of the focused edit control.
1114 // false Stop sending IPC message ViewHostMsg_ImeUpdateTextInputState.
1118 // This message sends a string being composed with an input method.
1120 ViewMsg_ImeSetComposition,
1126 // This message confirms an ongoing composition.
1131 // Sets the text composition to be between the given start and end offsets
1132 // in the currently focused editable field.
1138 // Selects between the given start and end offsets in the currently focused
1139 // editable field.
1144 // Deletes the current selection plus the specified number of characters before
1145 // and after the selection or caret.
1150 // Used to notify the render-view that we have received a target URL. Used
1151 // to prevent target URLs spamming the browser.
1155 // Sets the alternate error page URL (link doctor) for the renderer process.
1157 GURL)
1159 // Notifies the color chooser client that the user selected a color.
1162 // Notifies the color chooser client that the color chooser has ended.
1168 // Provides the results of directory enumeration.
1173 // When a renderer sends a ViewHostMsg_Focus to the browser process,
1174 // the browser has the option of sending a ViewMsg_CantFocus back to
1175 // the renderer.
1178 // Instructs the renderer to invoke the frame's shouldClose method, which
1179 // runs the onbeforeunload event handler. Expects the result to be returned
1180 // via ViewHostMsg_ShouldClose.
1183 // Instructs the renderer to swap out for a cross-site transition, including
1184 // running the unload event handler. See the struct above for more details.
1185 //
1186 // Expects a SwapOut_ACK message when finished, where the parameters are
1187 // echoed back.
1189 ViewMsg_SwapOut_Params)
1191 // Instructs the renderer to close the current page, including running the
1192 // onunload event handler.
1193 //
1194 // Expects a ClosePage_ACK message when finished.
1197 // Notifies the renderer about ui theme changes
1200 // Notifies the renderer that a paint is to be generated for the rectangle
1201 // passed in.
1205 // Notification that a move or resize renderer's containing window has
1206 // started.
1216 // Reply to ViewHostMsg_RequestMove, ViewHostMsg_ShowView, and
1217 // ViewHostMsg_ShowWidget to inform the renderer that the browser has
1218 // processed the move. The browser may have ignored the move, but it finished
1219 // processing. This is used because the renderer keeps a temporary cache of
1220 // the widget position while these asynchronous operations are in progress.
1223 // Used to instruct the RenderView to send back updates to the preferred size.
1226 // Used to instruct the RenderView to automatically resize and send back
1227 // updates for the new size.
1232 // Used to instruct the RenderView to disalbe automatically resize.
1236 // Changes the text direction of the currently selected input field (if any).
1240 // Tells the renderer to clear the focused node (if any).
1243 // Make the RenderView transparent and render it onto a custom background. The
1244 // background will be tiled in both directions if it is not large enough.
1248 // Used to tell the renderer not to add scrollbars with height and
1249 // width below a threshold.
1253 // Activate/deactivate the RenderView (i.e., set its controls' tint
1254 // accordingly, etc.).
1258 // Response message to ViewHostMsg_CreateShared/DedicatedWorker.
1259 // Sent when the worker has started.
1262 // The response to ViewHostMsg_AsyncOpenFile.
1268 // Tells the renderer that the network state has changed and that
1269 // window.navigator.onLine should be updated for all WebViews.
1273 // Reply to ViewHostMsg_OpenChannelToPpapiBroker
1274 // Tells the renderer that the channel to the broker has been created.
1280 // Reply to ViewHostMsg_RequestPpapiBrokerPermission.
1281 // Tells the renderer whether permission to access to PPAPI broker was granted
1282 // or not.
1287 // Tells the renderer to empty its plugin list cache, optional reloading
1288 // pages containing plugins.
1292 // Sent to the renderer when a popup window should no longer count against
1293 // the current popup count (either because it's not a popup or because it was
1294 // a generated by a user action).
1297 // Used to instruct the RenderView to go into "view source" mode.
1300 // Instructs the renderer to save the current page to MHTML.
1305 // Temporary message to diagnose an unexpected condition in WebContentsImpl.
1309 // Change the accessibility mode in the renderer process.
1311 AccessibilityMode)
1313 // An acknowledge to ViewHostMsg_MultipleTargetsTouched to notify the renderer
1314 // process to release the magnified image.
1318 // Notifies the renderer that a snapshot has been retrieved.
1324 // Tells the renderer to suspend/resume the webkit timers.
1328 #if defined(OS_ANDROID)
1329 // Sent when the user clicks on the find result bar to activate a find result.
1330 // The point (x,y) is in fractions of the content document's width and height.
1336 // Sent when the browser wants the bounding boxes of the current find matches.
1337 //
1338 // If match rects are already cached on the browser side, |current_version|
1339 // should be the version number from the ViewHostMsg_FindMatchRects_Reply
1340 // they came in, so the renderer can tell if it needs to send updated rects.
1341 // Otherwise just pass -1 to always receive the list of rects.
1342 //
1343 // There must be an active search string (it is probably most useful to call
1344 // this immediately after a ViewHostMsg_Find_Reply message arrives with
1345 // final_update set to true).
1349 // External popup menus.
1354 // Tells the renderer to try to revert to the zoom level we were at before
1355 // ViewMsg_ScrollFocusedEditableNodeIntoView was called.
1358 // This message relays the beginning or end of a batch event in the IME.
1362 // Notifies the renderer whether hiding/showing the top controls is enabled
1363 // and whether or not to animate to the proper state.
1371 #elif defined(OS_MACOSX)
1372 // Let the RenderView know its window has changed visibility.
1376 // Let the RenderView know its window's frame has changed.
1381 // Message sent from the browser to the renderer when the user starts or stops
1382 // resizing the view.
1386 // Tell the renderer that plugin IME has completed.
1391 // External popup menus.
1394 #endif
1396 // Sent by the browser as a reply to ViewHostMsg_SwapCompositorFrame.
1400 // Sent from the browser to ask the renderer for a snapshot of the current view.
1401 // The renderer replies with whether the snapshot succeeded and the SkBitmap.
1408 // -----------------------------------------------------------------------------
1409 // Messages sent from the renderer to the browser.
1411 // Sent by the renderer when it is creating a new window. The browser creates
1412 // a tab for it and responds with a ViewMsg_CreatingNew_ACK. If route_id is
1413 // MSG_ROUTING_NONE, the view couldn't be created.
1415 ViewHostMsg_CreateWindow_Params,
1420 // Similar to ViewHostMsg_CreateWindow, except used for sub-widgets, like
1421 // <select> dropdowns. This message is sent to the WebContentsImpl that
1422 // contains the widget being created.
1429 // Similar to ViewHostMsg_CreateWidget except the widget is a full screen
1430 // window.
1436 // Asks the browser for a unique routing ID.
1440 // Asks the browser for the default audio hardware configuration.
1445 // Asks the browser for CPU usage of the renderer process in percents.
1449 // Asks the browser for the user's monitor profile.
1453 // Asks the browser for the renderer process memory size stats.
1458 // These three messages are sent to the parent RenderViewHost to display the
1459 // page/widget that was created by
1460 // CreateWindow/CreateWidget/CreateFullscreenWidget. routing_id
1461 // refers to the id that was returned from the Create message above.
1462 // The initial_position parameter is a rectangle in screen coordinates.
1463 //
1464 // FUTURE: there will probably be flags here to control if the result is
1465 // in a new window.
1476 // Message to show a full screen widget.
1480 // This message is sent after ViewHostMsg_ShowView to cause the RenderView
1481 // to run in a modal fashion until it is closed.
1485 // Indicates the renderer is ready in response to a ViewMsg_New or
1486 // a ViewMsg_CreatingNew_ACK.
1489 // Indicates the renderer process is gone. This actually is sent by the
1490 // browser process to itself, but keeps the interface cleaner.
1495 // Sent by the renderer process to request that the browser close the view.
1496 // This corresponds to the window.close() API, and the browser may ignore
1497 // this message. Otherwise, the browser will generates a ViewMsg_Close
1498 // message to close the view.
1501 // Send in response to a ViewMsg_UpdateScreenRects so that the renderer can
1502 // throttle these messages.
1505 // Sent by the renderer process to request that the browser move the view.
1506 // This corresponds to the window.resizeTo() and window.moveTo() APIs, and
1507 // the browser may ignore this message.
1511 // Notifies the browser that a frame in the view has changed. This message
1512 // has a lot of parameters and is packed/unpacked by functions defined in
1513 // render_messages.h.
1515 ViewHostMsg_FrameNavigate_Params)
1517 // Used to tell the parent that the user right clicked on an area of the
1518 // content area, and a context menu should be shown for it. The params
1519 // object contains information about the node(s) that were selected when the
1520 // user right clicked.
1523 // Message to show a popup menu using native cocoa controls (Mac only).
1525 ViewHostMsg_ShowPopup_Params)
1527 // Response from ViewMsg_ScriptEvalRequest. The ID is the parameter supplied
1528 // to ViewMsg_ScriptEvalRequest. The result has the value returned by the
1529 // script as its only element, one of Null, Boolean, Integer, Real, Date, or
1530 // String.
1535 // Result of string search in the page.
1536 // Response to ViewMsg_Find with the results of the requested find-in-page
1537 // search, the number of matches found and the selection rect (in screen
1538 // coordinates) for the string found. If |final_update| is false, it signals
1539 // that this is not the last Find_Reply message - more will be sent as the
1540 // scoping effort continues.
1548 // Provides the result from running OnMsgShouldClose. |proceed| matches the
1549 // return value of the the frame's shouldClose method (which includes the
1550 // onbeforeunload handler): true if the user decided to proceed with leaving
1551 // the page.
1557 // Indicates that the current renderer has swapped out, after a SwapOut
1558 // message. The parameters are just echoed from the SwapOut request.
1560 ViewMsg_SwapOut_Params)
1562 // Indicates that the current page has been closed, after a ClosePage
1563 // message.
1566 // Notifies the browser that media has started/stopped playing.
1573 // Notifies the browser that we have session history information.
1574 // page_id: unique ID that allows us to distinguish between history entries.
1579 // Notifies the browser that a document has been loaded in a frame.
1583 // Notifies the browser that a frame finished loading.
1589 // Changes the title for the page in the UI when the page is navigated or the
1590 // title changes.
1596 // Change the encoding name of the page in UI when the page has detected
1597 // proper encoding name.
1601 // Notifies the browser that we want to show a destination url for a potential
1602 // action (e.g. when the user is hovering over a link).
1604 int32,
1605 GURL)
1607 // Sent when the renderer starts loading the page. This corresponds to
1608 // WebKit's notion of the throbber starting. Note that sometimes you may get
1609 // duplicates of these during a single load.
1612 // Sent when the renderer is done loading a page. This corresponds to WebKit's
1613 // notion of the throbber stopping.
1616 // Sent when the renderer main frame has made progress loading.
1620 // Sent when the renderer main frame sets its opener to null, disowning it for
1621 // the lifetime of the window.
1624 // Sent when the document element is available for the top-level frame. This
1625 // happens after the page starts loading, but before all resources are
1626 // finished.
1629 // Sent when after the onload handler has been invoked for the document
1630 // in the top-level frame.
1634 // Sent when the renderer loads a resource from its memory cache.
1635 // The security info is non empty if the resource was originally loaded over
1636 // a secure connection.
1637 // Note: May only be sent once per URL per frame per committed load.
1645 // Sent when the renderer displays insecure content in a secure page.
1648 // Sent when the renderer runs insecure content in a secure origin.
1653 // Sent when the renderer starts a provisional load for a frame.
1667 // Sent when the renderer fails a provisional load with an error.
1669 ViewHostMsg_DidFailProvisionalLoadWithError_Params)
1671 // Tells the render view that a ViewHostMsg_PaintAtSize message was
1672 // processed, and the DIB is ready for use. |tag| has the same value that
1673 // the tag sent along with ViewMsg_PaintAtSize.
1678 // Sent to update part of the view. In response to this message, the host
1679 // generates a ViewMsg_UpdateRect_ACK message.
1681 ViewHostMsg_UpdateRect_Params)
1683 // Sent to unblock the browser's UI thread if it is waiting on an UpdateRect,
1684 // which may get delayed until the browser's UI unblocks.
1687 // Sent by the renderer when accelerated compositing is enabled or disabled to
1688 // notify the browser whether or not is should do painting.
1692 // Acknowledges receipt of a ViewMsg_HandleInputEvent message.
1711 // Message sent from renderer to the browser when focus changes inside the
1712 // webpage. The parameter says whether the newly focused element needs
1713 // keyboard input (true for textfields, text areas and content editable divs).
1718 WebCursor)
1720 // Used to set a cookie. The cookie is set asynchronously, but will be
1721 // available to a subsequent ViewHostMsg_GetCookies request.
1727 // Used to get cookies for the given URL. This may block waiting for a
1728 // previous SetCookie message to be processed.
1734 // Used to get raw cookie information for the given URL. This may block
1735 // waiting for a previous SetCookie message to be processed.
1742 // Used to delete cookie for the given URL and name
1747 // Used to check if cookies are enabled for the given URL. This may block
1748 // waiting for a previous SetCookie message to be processed.
1754 // Used to get the list of plugins
1759 // Return information about a plugin for the given URL and MIME
1760 // type. If there is no matching plugin, |found| is false.
1761 // |actual_mime_type| is the actual mime type supported by the
1762 // found plugin.
1772 // A renderer sends this to the browser process when it wants to
1773 // create a plugin. The browser will create the plugin process if
1774 // necessary, and will return a handle to the channel on success.
1775 // On error an empty string is returned.
1784 #if defined(OS_WIN)
1790 #endif
1792 // Get the list of proxies to use for |url|, as a semicolon delimited list
1793 // of "<TYPE> <HOST>:<PORT>" | "DIRECT".
1799 // A renderer sends this to the browser process when it wants to create a
1800 // worker. The browser will create the worker process if necessary, and
1801 // will return the route id on success. On error returns MSG_ROUTING_NONE.
1803 ViewHostMsg_CreateWorker_Params,
1806 // This message is sent to the browser to see if an instance of this shared
1807 // worker already exists. If so, it returns exists == true. If a
1808 // non-empty name is passed, also validates that the url matches the url of
1809 // the existing worker. If a matching worker is found, the passed-in
1810 // document_id is associated with that worker, to ensure that the worker
1811 // stays alive until the document is detached.
1812 // The route_id returned can be used to forward messages to the worker via
1813 // ForwardToWorker if it exists, otherwise it should be passed in to any
1814 // future call to CreateWorker to avoid creating duplicate workers.
1816 ViewHostMsg_CreateWorker_Params,
1821 // A renderer sends this to the browser process when a document has been
1822 // detached. The browser will use this to constrain the lifecycle of worker
1823 // processes (SharedWorkers are shut down when their last associated document
1824 // is detached).
1828 // Wraps an IPC message that's destined to the worker on the renderer->browser
1829 // hop.
1833 // Tells the browser that a specific Appcache manifest in the current page
1834 // was accessed.
1839 // Initiates a download based on user actions like 'ALT+click'.
1845 // Used to go to the session history entry at the given offset (ie, -1 will
1846 // return the "back" item).
1850 // Sent from an inactive renderer for the browser to route to the active
1851 // renderer, instructing it to close.
1854 // Sent to the browser from an inactive renderer to post a message to the
1855 // active renderer.
1857 ViewMsg_PostMessage_Params)
1867 // Requests that the given URL be opened in the specified manner.
1870 // Notifies that the preferred size of the content changed.
1874 // Notifies that the scroll offset changed.
1875 // This is different from ViewHostMsg_UpdateRect in that ViewHostMsg_UpdateRect
1876 // is not sent at all when threaded compositing is enabled while
1877 // ViewHostMsg_DidChangeScrollOffset works properly in this case.
1880 // Notifies that the scrollbars-visible state of the content changed.
1885 // Notifies that the pinned-to-side state of the content changed.
1890 // Notifies that the number of JavaScript scroll handlers changed.
1894 // Notifies whether there are JavaScript touche event handlers or not.
1898 // A message from HTML-based UI. When (trusted) Javascript calls
1899 // send(message, args), this message is sent to the browser.
1905 // Requests a snapshot of the given window.
1909 // A renderer sends this to the browser process when it wants to create a ppapi
1910 // plugin. The browser will create the plugin process if necessary, and will
1911 // return a handle to the channel on success.
1912 //
1913 // The plugin_child_id is the ChildProcessHost ID assigned in the browser
1914 // process. This ID is valid only in the context of the browser process and is
1915 // used to identify the proper process when the renderer notifies it that the
1916 // plugin is hung.
1917 //
1918 // On error an empty string and null handles are returned.
1925 // Notification that a plugin has created a new plugin instance. The parameters
1926 // indicate:
1927 // -The plugin process ID that we're creating the instance for.
1928 // -The instance ID of the instance being created.
1929 // -A PepperRendererInstanceData struct which contains properties from the
1930 // renderer which are associated with the plugin instance. This includes the
1931 // routing ID of the associated render view and the URL of plugin.
1932 // -Whether the plugin we're creating an instance for is external or internal.
1933 //
1934 // This message must be sync even though it returns no parameters to avoid
1935 // a race condition with the plugin process. The plugin process sends messages
1936 // to the browser that assume the browser knows about the instance. We need to
1937 // make sure that the browser actually knows about the instance before we tell
1938 // the plugin to run.
1940 ViewHostMsg_DidCreateOutOfProcessPepperInstance,
1946 // Notification that a plugin has destroyed an instance. This is the opposite of
1947 // the "DidCreate" message above.
1953 // A renderer sends this to the browser process when it wants to
1954 // create a ppapi broker. The browser will create the broker process
1955 // if necessary, and will return a handle to the channel on success.
1956 // On error an empty string is returned.
1957 // The browser will respond with ViewMsg_PpapiBrokerChannelCreated.
1963 // A renderer sends this to the browser process when it wants to access a PPAPI
1964 // broker. In contrast to ViewHostMsg_OpenChannelToPpapiBroker, this is called
1965 // for every connection.
1966 // The browser will respond with ViewMsg_PpapiBrokerPermissionResult.
1972 #if defined(USE_X11)
1973 // A renderer sends this when it needs a browser-side widget for
1974 // hosting a windowed plugin. id is the XID of the plugin window, for which
1975 // the container is created.
1979 // Destroy a plugin container previously created using CreatePluginContainer.
1980 // id is the XID of the plugin window corresponding to the container that is
1981 // to be destroyed.
1984 #endif
1986 // Send the tooltip text for the current mouse position to the browser.
1994 // Notification that the text selection has changed.
1995 // Note: The secound parameter is the character based offset of the string16
1996 // text in the document.
2002 // Notification that the selection bounds have changed.
2004 ViewHostMsg_SelectionBounds_Params)
2006 // Asks the browser to open the color chooser.
2011 // Asks the browser to end the color chooser.
2014 // Change the selected color in the color chooser.
2019 // Asks the browser to display the file chooser. The result is returned in a
2020 // ViewHost_RunFileChooserResponse message.
2024 // Asks the browser to enumerate a directory. This is equivalent to running
2025 // the file chooser in directory-enumeration mode and having the user select
2026 // the given directory. The result is returned in a
2027 // ViewMsg_EnumerateDirectoryResponse message.
2032 // Tells the browser to move the focus to the next (previous if reverse is
2033 // true) focusable element.
2037 // Required for opening a date/time dialog
2041 // Required for updating text input state.
2045 // Message sent when the IME text composition range changes.
2050 // Required for cancelling an ongoing input method composition.
2053 // WebKit and JavaScript error messages to log to the console
2054 // or debugger UI.
2061 // Sent by the renderer process to indicate that a plugin instance has crashed.
2062 // Note: |plugin_pid| should not be trusted. The corresponding process has
2063 // probably died. Moreover, the ID may have been reused by a new process. Any
2064 // usage other than displaying it in a prompt to the user is very likely to be
2065 // wrong.
2070 // Displays a box to confirm that the user wants to navigate away from the
2071 // page. Replies true if yes, false otherwise, the reply string is ignored,
2072 // but is included so that we can use OnJavaScriptMessageBoxClosed.
2080 // Sent when a provisional load on the main frame redirects.
2086 // Sent when the renderer changes the zoom level for a particular url, so the
2087 // browser can update its records. If remember is true, then url is used to
2088 // update the zoom level for all pages in that site. Otherwise, the render
2089 // view's id is used so that only the menu is updated.
2095 // Updates the minimum/maximum allowed zoom percent for this tab from the
2096 // default values. If |remember| is true, then the zoom setting is applied to
2097 // other pages in the site and is saved, otherwise it only applies to this
2098 // tab.
2104 // Notify the browser that this render process can or can't be suddenly
2105 // terminated.
2109 // Informs the browser of updated frame names.
2115 // This message is synthesized by GpuProcessHost to pass through a swap message
2116 // to the RenderWidgetHelper. This allows GetBackingStore to block for either a
2117 // software or GPU frame.
2128 // Opens a file asynchronously. The response returns a file descriptor
2129 // and an error code from base/platform_file.h.
2135 //---------------------------------------------------------------------------
2136 // Request for cryptographic operation messages:
2137 // These are messages from the renderer to the browser to perform a
2138 // cryptographic operation.
2140 // Asks the browser process to generate a keypair for grabbing a client
2141 // certificate from a CA (<keygen> tag), and returns the signed public
2142 // key and challenge string.
2149 // Message sent from the renderer to the browser to request that the browser
2150 // cache |data| associated with |url|.
2156 // Updates the content restrictions, i.e. to disable print/copy.
2160 // Brings up SaveAs... dialog to save specified URL.
2165 // Displays a JavaScript out-of-memory message in the infobar.
2168 // Register a new handler for URL requests with the given scheme.
2175 // Stores new inspector setting in the profile.
2176 // TODO(jam): this should be in the chrome module
2181 // Puts the browser into "tab fullscreen" mode for the sending renderer.
2182 // See the comment in chrome/browser/ui/browser.h for more details.
2186 // Send back a string to be recorded by UserMetrics.
2190 // Notifies the browser that the page was or was not saved as MHTML.
2205 // Notifies the browser of an event occurring in the media pipeline.
2209 // Requests to lock the mouse. Will result in a ViewMsg_LockMouse_ACK message
2210 // being sent back.
2211 // |privileged| is used by Pepper Flash. If this flag is set to true, we won't
2212 // pop up a bubble to ask for user permission or take mouse lock content into
2213 // account.
2219 // Requests to unlock the mouse. A ViewMsg_MouseLockLost message will be sent
2220 // whenever the mouse is unlocked (which may or may not be caused by
2221 // ViewHostMsg_UnlockMouse).
2224 // Following message is used to communicate the values received by the
2225 // callback binding the JS to Cpp.
2226 // An instance of browser that has an automation host listening to it can
2227 // have a javascript send a native value (string, number, boolean) to the
2228 // listener in Cpp. (DomAutomationController)
2233 // Sent to the browser when the renderer detects it is blocked on a pepper
2234 // plugin message for too long. This is also sent when it becomes unhung
2235 // (according to the value of is_hung). The browser can give the user the
2236 // option of killing the plugin.
2242 // Chrome allows JavaScript calls to be routed across process boundaries. To
2243 // achieve this, each active RenderView in the source process has a swapped out
2244 // "mirror" in the target process. The active RenderView and its mirror
2245 // need to have identical frame tree structure, so calls originating in and
2246 // targeting subframes can be routed properly. This is achieved by each active
2247 // RenderView sending a ViewHostMsg_FrameTreeUpdated message to the browser,
2248 // which in turn sends the update to the corresponding mirror RenderView(s)
2249 // through the ViewMsg_UpdateFrameTree. We use best effort to keep these
2250 // trees synchronized across processes.
2251 //
2252 // When routing JavaScript calls across processes, the target information
2253 // is kept in the renderer process instead of the browser process. This design
2254 // was chosen because frame ids are allocated by the renderer process. If the
2255 // browser was to keep a mapping of the frame ids across processes, it would
2256 // require an extra IPC message with the newly allocated frame ids, as a
2257 // response to this particular message.
2258 //
2259 // The frame tree for a RenderView is serialized to JSON, so it can be sent to
2260 // the browser process. Each node in the tree is an object with three
2261 // properties:
2262 // * id - (integer) the frame identifier in this RenderView
2263 // * name - (string) the name of the frame, if one has been assigned
2264 // * subtree - an array of the same type of objects for each frame that is a
2265 // direct child of the current frame. This property can be omitted if
2266 // there are no direct child frames, so less data is transferred.
2267 //
2268 // This message must be sent on any events that modify the tree structure or
2269 // the names of any frames.
2273 // Notifies that multiple touch targets may have been pressed, and to show
2274 // the disambiguation popup.
2280 // Sent by the renderer process to check whether client 3D APIs
2281 // (Pepper 3D, WebGL) are explicitly blocked.
2288 // Sent by the renderer process to indicate that a context was lost by
2289 // client 3D content (Pepper 3D, WebGL) running on the page at the
2290 // given URL.
2296 // Notifies the browser that the frame with the given id was detached.
2300 // Notifies the browser that document has parsed the body. This is used by the
2301 // ResourceScheduler as an indication that bandwidth contention won't block
2302 // first paint.
2305 // Notification that the urls for the favicon of a site has been determined.
2310 // Sent once a paint happens after the first non empty layout. In other words
2311 // after the page has painted something.
2315 #if defined(OS_ANDROID)
2316 // Response to ViewMsg_FindMatchRects.
2317 //
2318 // |version| will contain the current version number of the renderer's find
2319 // match list (incremented whenever they change), which should be passed in the
2320 // next call to ViewMsg_FindMatchRects.
2321 //
2322 // |rects| will either contain a list of the enclosing rects of all matches
2323 // found by the most recent Find operation, or will be empty if |version| is not
2324 // greater than the |current_version| passed to ViewMsg_FindMatchRects (hence
2325 // your locally cached rects should still be valid). The rect coords will be
2326 // custom normalized fractions of the document size. The rects will be sorted by
2327 // frame traversal order starting in the main frame, then by dom order.
2328 //
2329 // |active_rect| will contain the bounding box of the active find-in-page match
2330 // marker, in similarly normalized coords (or an empty rect if there isn't one).
2336 // Start an android intent with the given URI.
2340 // Message sent when the renderer changed the background color for the view.
2344 // Information about current document scroll, scale and size. Sent on a
2345 // best-effort basis.
2353 // This message is an ACK that the batch state change has been received by
2354 // the renderer and all IME related messages should be processed accordingly.
2358 // This message runs the MediaCodec for decoding audio for webaudio.
2363 #elif defined(OS_MACOSX)
2364 // Request that the browser load a font into shared memory for us.
2371 // On OSX, we cannot allocated shared memory from within the sandbox, so
2372 // this call exists for the renderer to ask the browser to allocate memory
2373 // on its behalf. We return a file descriptor to the POSIX shared memory.
2374 // If the |cache_in_browser| flag is |true|, then a copy of the shmem is kept
2375 // by the browser, and it is the caller's repsonsibility to send a
2376 // ViewHostMsg_FreeTransportDIB message in order to release the cached shmem.
2377 // In all cases, the caller is responsible for deleting the resulting
2378 // TransportDIB.
2384 // Since the browser keeps handles to the allocated transport DIBs, this
2385 // message is sent to tell the browser that it may release them when the
2386 // renderer is finished with them.
2390 // Informs the browser that a plugin has gained or lost focus.
2395 // Instructs the browser to start plugin IME.
2398 #elif defined(OS_WIN)
2399 // Request that the given font characters be loaded by the browser so it's
2400 // cached by the OS. Please see RenderMessageFilter::OnPreCacheFontCharacters
2401 // for details.
2405 #endif
2407 // Adding a new message? Stick to the sort order above: first platform
2408 // independent ViewMsg, then ifdefs for platform specific ViewMsg, then platform
2409 // independent ViewHostMsg, then ifdefs for platform specific ViewHostMsg.