123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897 |
- namespace Xilium.CefGlue
- {
- using System;
- using System.Collections.Generic;
- using System.Diagnostics;
- using System.Runtime.InteropServices;
- using Xilium.CefGlue.Interop;
- /// <summary>
- /// Class used to represent the browser process aspects of a browser window. The
- /// methods of this class can only be called in the browser process. They may be
- /// called on any thread in that process unless otherwise indicated in the
- /// comments.
- /// </summary>
- public sealed unsafe partial class CefBrowserHost
- {
- /// <summary>
- /// Create a new browser window using the window parameters specified by
- /// |windowInfo|. All values will be copied internally and the actual window
- /// will be created on the UI thread. If |request_context| is empty the
- /// global request context will be used. This method can be called on any
- /// browser process thread and will not block. The optional |extra_info|
- /// parameter provides an opportunity to specify extra information specific
- /// to the created browser that will be passed to
- /// CefRenderProcessHandler::OnBrowserCreated() in the render process.
- /// </summary>
- public static void CreateBrowser(CefWindowInfo windowInfo, CefClient client, CefBrowserSettings settings, string url, CefDictionaryValue extraInfo = null, CefRequestContext requestContext = null)
- {
- if (windowInfo == null) throw new ArgumentNullException("windowInfo");
- if (client == null) throw new ArgumentNullException("client");
- if (settings == null) throw new ArgumentNullException("settings");
- // TODO: [ApiUsage] if windowInfo.WindowRenderingDisabled && client doesn't provide RenderHandler implementation -> throw exception
- var n_windowInfo = windowInfo.GetNativePointer();
- var n_client = client.ToNative();
- var n_settings = settings.ToNative();
- var n_extraInfo = extraInfo != null ? extraInfo.ToNative() : null;
- var n_requestContext = requestContext != null ? requestContext.ToNative() : null;
- fixed (char* url_ptr = url)
- {
- cef_string_t n_url = new cef_string_t(url_ptr, url != null ? url.Length : 0);
- var n_success = cef_browser_host_t.create_browser(n_windowInfo, n_client, &n_url, n_settings, n_extraInfo, n_requestContext);
- if (n_success != 1) throw ExceptionBuilder.FailedToCreateBrowser(n_success);
- }
- }
- /// <summary>
- /// Create a new browser window using the window parameters specified by
- /// |windowInfo|. If |request_context| is empty the global request context
- /// will be used. This method can only be called on the browser process UI
- /// thread. The optional |extra_info| parameter provides an opportunity to
- /// specify extra information specific to the created browser that will be
- /// passed to CefRenderProcessHandler::OnBrowserCreated() in the render
- /// process.
- /// </summary>
- public static CefBrowser CreateBrowserSync(CefWindowInfo windowInfo, CefClient client, CefBrowserSettings settings, string url, CefDictionaryValue extraInfo = null, CefRequestContext requestContext = null)
- {
- if (windowInfo == null) throw new ArgumentNullException("windowInfo");
- if (client == null) throw new ArgumentNullException("client");
- if (settings == null) throw new ArgumentNullException("settings");
- // TODO: [ApiUsage] if windowInfo.WindowRenderingDisabled && client doesn't provide RenderHandler implementation -> throw exception
- var n_windowInfo = windowInfo.GetNativePointer();
- var n_client = client.ToNative();
- var n_settings = settings.ToNative();
- var n_extraInfo = extraInfo != null ? extraInfo.ToNative() : null;
- var n_requestContext = requestContext != null ? requestContext.ToNative() : null;
- fixed (char* url_ptr = url)
- {
- cef_string_t n_url = new cef_string_t(url_ptr, url != null ? url.Length : 0);
- var n_browser = cef_browser_host_t.create_browser_sync(n_windowInfo, n_client, &n_url, n_settings, n_extraInfo, n_requestContext);
- return CefBrowser.FromNative(n_browser);
- }
- }
- /// <summary>
- /// Returns the hosted browser object.
- /// </summary>
- public CefBrowser GetBrowser()
- {
- return CefBrowser.FromNative(cef_browser_host_t.get_browser(_self));
- }
- /// <summary>
- /// Request that the browser close. The JavaScript 'onbeforeunload' event will
- /// be fired. If |force_close| is false the event handler, if any, will be
- /// allowed to prompt the user and the user can optionally cancel the close.
- /// If |force_close| is true the prompt will not be displayed and the close
- /// will proceed. Results in a call to CefLifeSpanHandler::DoClose() if the
- /// event handler allows the close or if |force_close| is true. See
- /// CefLifeSpanHandler::DoClose() documentation for additional usage
- /// information.
- /// </summary>
- public void CloseBrowser(bool forceClose = false)
- {
- cef_browser_host_t.close_browser(_self, forceClose ? 1 : 0);
- }
- /// <summary>
- /// Helper for closing a browser. Call this method from the top-level window
- /// close handler. Internally this calls CloseBrowser(false) if the close has
- /// not yet been initiated. This method returns false while the close is
- /// pending and true after the close has completed. See CloseBrowser() and
- /// CefLifeSpanHandler::DoClose() documentation for additional usage
- /// information. This method must be called on the browser process UI thread.
- /// </summary>
- public bool TryCloseBrowser()
- {
- return cef_browser_host_t.try_close_browser(_self) != 0;
- }
- /// <summary>
- /// Set whether the browser is focused.
- /// </summary>
- public void SetFocus(bool focus)
- {
- cef_browser_host_t.set_focus(_self, focus ? 1 : 0);
- }
- /// <summary>
- /// Retrieve the window handle for this browser. If this browser is wrapped in
- /// a CefBrowserView this method should be called on the browser process UI
- /// thread and it will return the handle for the top-level native window.
- /// </summary>
- public IntPtr GetWindowHandle()
- {
- return cef_browser_host_t.get_window_handle(_self);
- }
- /// <summary>
- /// Retrieve the window handle of the browser that opened this browser. Will
- /// return NULL for non-popup windows or if this browser is wrapped in a
- /// CefBrowserView. This method can be used in combination with custom handling
- /// of modal windows.
- /// </summary>
- public IntPtr GetOpenerWindowHandle()
- {
- return cef_browser_host_t.get_opener_window_handle(_self);
- }
- /// <summary>
- /// Returns true if this browser is wrapped in a CefBrowserView.
- /// </summary>
- public bool HasView
- {
- get { return cef_browser_host_t.has_view(_self) != 0; }
- }
- /// <summary>
- /// Returns the client for this browser.
- /// </summary>
- public CefClient GetClient()
- {
- return CefClient.FromNative(
- cef_browser_host_t.get_client(_self)
- );
- }
- /// <summary>
- /// Returns the request context for this browser.
- /// </summary>
- public CefRequestContext GetRequestContext()
- {
- return CefRequestContext.FromNative(
- cef_browser_host_t.get_request_context(_self)
- );
- }
- /// <summary>
- /// Get the current zoom level. The default zoom level is 0.0. This method can
- /// only be called on the UI thread.
- /// </summary>
- public double GetZoomLevel()
- {
- return cef_browser_host_t.get_zoom_level(_self);
- }
- /// <summary>
- /// Change the zoom level to the specified value. Specify 0.0 to reset the
- /// zoom level. If called on the UI thread the change will be applied
- /// immediately. Otherwise, the change will be applied asynchronously on the
- /// UI thread.
- /// </summary>
- public void SetZoomLevel(double value)
- {
- cef_browser_host_t.set_zoom_level(_self, value);
- }
- /// <summary>
- /// Call to run a file chooser dialog. Only a single file chooser dialog may be
- /// pending at any given time. |mode| represents the type of dialog to display.
- /// |title| to the title to be used for the dialog and may be empty to show the
- /// default title ("Open" or "Save" depending on the mode). |default_file_path|
- /// is the path with optional directory and/or file name component that will be
- /// initially selected in the dialog. |accept_filters| are used to restrict the
- /// selectable file types and may any combination of (a) valid lower-cased MIME
- /// types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g.
- /// ".txt" or ".png"), or (c) combined description and file extension delimited
- /// using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg").
- /// |selected_accept_filter| is the 0-based index of the filter that will be
- /// selected by default. |callback| will be executed after the dialog is
- /// dismissed or immediately if another dialog is already pending. The dialog
- /// will be initiated asynchronously on the UI thread.
- /// </summary>
- public void RunFileDialog(CefFileDialogMode mode, string title, string defaultFilePath, string[] acceptFilters, int selectedAcceptFilter, CefRunFileDialogCallback callback)
- {
- if (callback == null) throw new ArgumentNullException("callback");
- fixed (char* title_ptr = title)
- fixed (char* defaultFilePath_ptr = defaultFilePath)
- {
- var n_title = new cef_string_t(title_ptr, title != null ? title.Length : 0);
- var n_defaultFilePath = new cef_string_t(defaultFilePath_ptr, defaultFilePath != null ? defaultFilePath.Length : 0);
- var n_acceptFilters = cef_string_list.From(acceptFilters);
- cef_browser_host_t.run_file_dialog(_self, mode, &n_title, &n_defaultFilePath, n_acceptFilters, selectedAcceptFilter, callback.ToNative());
- libcef.string_list_free(n_acceptFilters);
- }
- }
- /// <summary>
- /// Download the file at |url| using CefDownloadHandler.
- /// </summary>
- public void StartDownload(string url)
- {
- if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url");
- fixed (char* url_ptr = url)
- {
- var n_url = new cef_string_t(url_ptr, url.Length);
- cef_browser_host_t.start_download(_self, &n_url);
- }
- }
- /// <summary>
- /// Download |image_url| and execute |callback| on completion with the images
- /// received from the renderer. If |is_favicon| is true then cookies are not
- /// sent and not accepted during download. Images with density independent
- /// pixel (DIP) sizes larger than |max_image_size| are filtered out from the
- /// image results. Versions of the image at different scale factors may be
- /// downloaded up to the maximum scale factor supported by the system. If there
- /// are no image results <= |max_image_size| then the smallest image is resized
- /// to |max_image_size| and is the only result. A |max_image_size| of 0 means
- /// unlimited. If |bypass_cache| is true then |image_url| is requested from the
- /// server even if it is present in the browser cache.
- /// </summary>
- public void DownloadImage(string imageUrl, bool isFavIcon, uint maxImageSize, bool bypassCache, CefDownloadImageCallback callback)
- {
- if (string.IsNullOrEmpty(imageUrl)) throw new ArgumentNullException("imageUrl");
- fixed (char* imageUrl_ptr = imageUrl)
- {
- var n_imageUrl = new cef_string_t(imageUrl_ptr, imageUrl.Length);
- var n_callback = callback.ToNative();
- cef_browser_host_t.download_image(_self, &n_imageUrl, isFavIcon ? 1 : 0, maxImageSize, bypassCache ? 1 : 0, n_callback);
- }
- }
- /// <summary>
- /// Print the current browser contents.
- /// </summary>
- public void Print()
- {
- cef_browser_host_t.print(_self);
- }
- /// <summary>
- /// Print the current browser contents to the PDF file specified by |path| and
- /// execute |callback| on completion. The caller is responsible for deleting
- /// |path| when done. For PDF printing to work on Linux you must implement the
- /// CefPrintHandler::GetPdfPaperSize method.
- /// </summary>
- public void PrintToPdf(string path, CefPdfPrintSettings settings, CefPdfPrintCallback callback)
- {
- fixed (char* path_ptr = path)
- {
- var n_path = new cef_string_t(path_ptr, path.Length);
- var n_settings = settings.ToNative();
- cef_browser_host_t.print_to_pdf(_self,
- &n_path,
- n_settings,
- callback.ToNative()
- );
- cef_pdf_print_settings_t.Clear(n_settings);
- cef_pdf_print_settings_t.Free(n_settings);
- }
- }
- /// <summary>
- /// Search for |searchText|. |identifier| must be a unique ID and these IDs
- /// must strictly increase so that newer requests always have greater IDs than
- /// older requests. If |identifier| is zero or less than the previous ID value
- /// then it will be automatically assigned a new valid ID. |forward| indicates
- /// whether to search forward or backward within the page. |matchCase|
- /// indicates whether the search should be case-sensitive. |findNext| indicates
- /// whether this is the first request or a follow-up. The CefFindHandler
- /// instance, if any, returned via CefClient::GetFindHandler will be called to
- /// report find results.
- /// </summary>
- public void Find(int identifier, string searchText, bool forward, bool matchCase, bool findNext)
- {
- fixed (char* searchText_ptr = searchText)
- {
- var n_searchText = new cef_string_t(searchText_ptr, searchText.Length);
- cef_browser_host_t.find(_self, identifier, &n_searchText, forward ? 1 : 0, matchCase ? 1 : 0, findNext ? 1 : 0);
- }
- }
- /// <summary>
- /// Cancel all searches that are currently going on.
- /// </summary>
- public void StopFinding(bool clearSelection)
- {
- cef_browser_host_t.stop_finding(_self, clearSelection ? 1 : 0);
- }
- /// <summary>
- /// Open developer tools (DevTools) in its own browser. The DevTools browser
- /// will remain associated with this browser. If the DevTools browser is
- /// already open then it will be focused, in which case the |windowInfo|,
- /// |client| and |settings| parameters will be ignored. If |inspect_element_at|
- /// is non-empty then the element at the specified (x,y) location will be
- /// inspected. The |windowInfo| parameter will be ignored if this browser is
- /// wrapped in a CefBrowserView.
- /// </summary>
- public void ShowDevTools(CefWindowInfo windowInfo, CefClient client, CefBrowserSettings browserSettings, CefPoint inspectElementAt)
- {
- var n_inspectElementAt = new cef_point_t(inspectElementAt.X, inspectElementAt.Y);
- cef_browser_host_t.show_dev_tools(_self, windowInfo.ToNative(), client.ToNative(), browserSettings.ToNative(),
- &n_inspectElementAt);
- }
- /// <summary>
- /// Explicitly close the associated DevTools browser, if any.
- /// </summary>
- public void CloseDevTools()
- {
- cef_browser_host_t.close_dev_tools(_self);
- }
- /// <summary>
- /// Returns true if this browser currently has an associated DevTools browser.
- /// Must be called on the browser process UI thread.
- /// </summary>
- public bool HasDevTools
- {
- get
- {
- return cef_browser_host_t.has_dev_tools(_self) != 0;
- }
- }
- /// <summary>
- /// Send a method call message over the DevTools protocol. |message| must be a
- /// UTF8-encoded JSON dictionary that contains "id" (int), "method" (string)
- /// and "params" (dictionary, optional) values. See the DevTools protocol
- /// documentation at https://chromedevtools.github.io/devtools-protocol/ for
- /// details of supported methods and the expected "params" dictionary contents.
- /// |message| will be copied if necessary. This method will return true if
- /// called on the UI thread and the message was successfully submitted for
- /// validation, otherwise false. Validation will be applied asynchronously and
- /// any messages that fail due to formatting errors or missing parameters may
- /// be discarded without notification. Prefer ExecuteDevToolsMethod if a more
- /// structured approach to message formatting is desired.
- /// Every valid method call will result in an asynchronous method result or
- /// error message that references the sent message "id". Event messages are
- /// received while notifications are enabled (for example, between method calls
- /// for "Page.enable" and "Page.disable"). All received messages will be
- /// delivered to the observer(s) registered with AddDevToolsMessageObserver.
- /// See CefDevToolsMessageObserver::OnDevToolsMessage documentation for details
- /// of received message contents.
- /// Usage of the SendDevToolsMessage, ExecuteDevToolsMethod and
- /// AddDevToolsMessageObserver methods does not require an active DevTools
- /// front-end or remote-debugging session. Other active DevTools sessions will
- /// continue to function independently. However, any modification of global
- /// browser state by one session may not be reflected in the UI of other
- /// sessions.
- /// Communication with the DevTools front-end (when displayed) can be logged
- /// for development purposes by passing the
- /// `--devtools-protocol-log-file=<path>` command-line flag.
- /// </summary>
- public bool SendDevToolsMessage(IntPtr message, int messageSize)
- {
- return cef_browser_host_t.send_dev_tools_message(
- _self, (void*)message, checked((UIntPtr)messageSize)) != 0;
- }
- /// <summary>
- /// Execute a method call over the DevTools protocol. This is a more structured
- /// version of SendDevToolsMessage. |message_id| is an incremental number that
- /// uniquely identifies the message (pass 0 to have the next number assigned
- /// automatically based on previous values). |method| is the method name.
- /// |params| are the method parameters, which may be empty. See the DevTools
- /// protocol documentation (linked above) for details of supported methods and
- /// the expected |params| dictionary contents. This method will return the
- /// assigned message ID if called on the UI thread and the message was
- /// successfully submitted for validation, otherwise 0. See the
- /// SendDevToolsMessage documentation for additional usage information.
- /// </summary>
- public int ExecuteDevToolsMethod(int messageId, string method, CefDictionaryValue parameters)
- {
- fixed (char* method_str = method)
- {
- var n_method = new cef_string_t(method_str, method != null ? method.Length : 0);
- return cef_browser_host_t.execute_dev_tools_method(
- _self, messageId, &n_method, parameters.ToNative());
- }
- }
- /// <summary>
- /// Add an observer for DevTools protocol messages (method results and events).
- /// The observer will remain registered until the returned Registration object
- /// is destroyed. See the SendDevToolsMessage documentation for additional
- /// usage information.
- /// </summary>
- public CefRegistration AddDevToolsMessageObserver(CefDevToolsMessageObserver observer)
- {
- if (observer == null) throw new ArgumentNullException(nameof(observer));
- var n_registration = cef_browser_host_t.add_dev_tools_message_observer(_self,
- observer.ToNative());
- return CefRegistration.FromNativeOrNull(n_registration);
- }
- /// <summary>
- /// Retrieve a snapshot of current navigation entries as values sent to the
- /// specified visitor. If |current_only| is true only the current navigation
- /// entry will be sent, otherwise all navigation entries will be sent.
- /// </summary>
- public void GetNavigationEntries(CefNavigationEntryVisitor visitor, bool currentOnly)
- {
- cef_browser_host_t.get_navigation_entries(_self, visitor.ToNative(), currentOnly ? 1 : 0);
- }
- /// <summary>
- /// If a misspelled word is currently selected in an editable node calling
- /// this method will replace it with the specified |word|.
- /// </summary>
- public void ReplaceMisspelling(string word)
- {
- fixed (char* word_str = word)
- {
- var n_word = new cef_string_t(word_str, word != null ? word.Length : 0);
- cef_browser_host_t.replace_misspelling(_self, &n_word);
- }
- }
- /// <summary>
- /// Add the specified |word| to the spelling dictionary.
- /// </summary>
- public void AddWordToDictionary(string word)
- {
- fixed (char* word_str = word)
- {
- var n_word = new cef_string_t(word_str, word != null ? word.Length : 0);
- cef_browser_host_t.add_word_to_dictionary(_self, &n_word);
- }
- }
- /// <summary>
- /// Returns true if window rendering is disabled.
- /// </summary>
- public bool IsWindowRenderingDisabled
- {
- get
- {
- return cef_browser_host_t.is_window_rendering_disabled(_self) != 0;
- }
- }
- /// <summary>
- /// Notify the browser that the widget has been resized. The browser will first
- /// call CefRenderHandler::GetViewRect to get the new size and then call
- /// CefRenderHandler::OnPaint asynchronously with the updated regions. This
- /// method is only used when window rendering is disabled.
- /// </summary>
- public void WasResized()
- {
- cef_browser_host_t.was_resized(_self);
- }
- /// <summary>
- /// Notify the browser that it has been hidden or shown. Layouting and
- /// CefRenderHandler::OnPaint notification will stop when the browser is
- /// hidden. This method is only used when window rendering is disabled.
- /// </summary>
- public void WasHidden(bool hidden)
- {
- cef_browser_host_t.was_hidden(_self, hidden ? 1 : 0);
- }
- /// <summary>
- /// Send a notification to the browser that the screen info has changed. The
- /// browser will then call CefRenderHandler::GetScreenInfo to update the
- /// screen information with the new values. This simulates moving the webview
- /// window from one display to another, or changing the properties of the
- /// current display. This method is only used when window rendering is
- /// disabled.
- /// </summary>
- public void NotifyScreenInfoChanged()
- {
- cef_browser_host_t.notify_screen_info_changed(_self);
- }
- /// <summary>
- /// Invalidate the view. The browser will call CefRenderHandler::OnPaint
- /// asynchronously. This method is only used when window rendering is
- /// disabled.
- /// </summary>
- public void Invalidate(CefPaintElementType type)
- {
- cef_browser_host_t.invalidate(_self, type);
- }
- /// <summary>
- /// Issue a BeginFrame request to Chromium. Only valid when
- /// CefWindowInfo::external_begin_frame_enabled is set to true.
- /// </summary>
- public void SendExternalBeginFrame()
- {
- cef_browser_host_t.send_external_begin_frame(_self);
- }
- /// <summary>
- /// Send a key event to the browser.
- /// </summary>
- public void SendKeyEvent(CefKeyEvent keyEvent)
- {
- if (keyEvent == null) throw new ArgumentNullException("keyEvent");
- var n_event = new cef_key_event_t();
- keyEvent.ToNative(&n_event);
- cef_browser_host_t.send_key_event(_self, &n_event);
- }
- /// <summary>
- /// Send a mouse click event to the browser. The |x| and |y| coordinates are
- /// relative to the upper-left corner of the view.
- /// </summary>
- public void SendMouseClickEvent(CefMouseEvent @event, CefMouseButtonType type, bool mouseUp, int clickCount)
- {
- var n_event = @event.ToNative();
- cef_browser_host_t.send_mouse_click_event(_self, &n_event, type, mouseUp ? 1 : 0, clickCount);
- }
- /// <summary>
- /// Send a mouse move event to the browser. The |x| and |y| coordinates are
- /// relative to the upper-left corner of the view.
- /// </summary>
- public void SendMouseMoveEvent(CefMouseEvent @event, bool mouseLeave)
- {
- var n_event = @event.ToNative();
- cef_browser_host_t.send_mouse_move_event(_self, &n_event, mouseLeave ? 1 : 0);
- }
- /// <summary>
- /// Send a mouse wheel event to the browser. The |x| and |y| coordinates are
- /// relative to the upper-left corner of the view. The |deltaX| and |deltaY|
- /// values represent the movement delta in the X and Y directions respectively.
- /// In order to scroll inside select popups with window rendering disabled
- /// CefRenderHandler::GetScreenPoint should be implemented properly.
- /// </summary>
- public void SendMouseWheelEvent(CefMouseEvent @event, int deltaX, int deltaY)
- {
- var n_event = @event.ToNative();
- cef_browser_host_t.send_mouse_wheel_event(_self, &n_event, deltaX, deltaY);
- }
- /// <summary>
- /// Send a touch event to the browser for a windowless browser.
- /// </summary>
- public void SendTouchEvent(CefTouchEvent @event)
- {
- cef_touch_event_t n_event;
- @event.ToNative(out n_event);
- cef_browser_host_t.send_touch_event(_self, &n_event);
- }
- /// <summary>
- /// Send a focus event to the browser.
- /// </summary>
- public void SendFocusEvent(bool setFocus)
- {
- cef_browser_host_t.send_focus_event(_self, setFocus ? 1 : 0);
- }
- /// <summary>
- /// Send a capture lost event to the browser.
- /// </summary>
- public void SendCaptureLostEvent()
- {
- cef_browser_host_t.send_capture_lost_event(_self);
- }
- /// <summary>
- /// Notify the browser that the window hosting it is about to be moved or
- /// resized. This method is only used on Windows and Linux.
- /// </summary>
- public void NotifyMoveOrResizeStarted()
- {
- cef_browser_host_t.notify_move_or_resize_started(_self);
- }
- /// <summary>
- /// Returns the maximum rate in frames per second (fps) that CefRenderHandler::
- /// OnPaint will be called for a windowless browser. The actual fps may be
- /// lower if the browser cannot generate frames at the requested rate. The
- /// minimum value is 1 and the maximum value is 60 (default 30). This method
- /// can only be called on the UI thread.
- /// </summary>
- public int GetWindowlessFrameRate()
- {
- return cef_browser_host_t.get_windowless_frame_rate(_self);
- }
- /// <summary>
- /// Set the maximum rate in frames per second (fps) that CefRenderHandler::
- /// OnPaint will be called for a windowless browser. The actual fps may be
- /// lower if the browser cannot generate frames at the requested rate. The
- /// minimum value is 1 and the maximum value is 60 (default 30). Can also be
- /// set at browser creation via CefBrowserSettings.windowless_frame_rate.
- /// </summary>
- public void SetWindowlessFrameRate(int frameRate)
- {
- cef_browser_host_t.set_windowless_frame_rate(_self, frameRate);
- }
- /// <summary>
- /// Begins a new composition or updates the existing composition. Blink has a
- /// special node (a composition node) that allows the input method to change
- /// text without affecting other DOM nodes. |text| is the optional text that
- /// will be inserted into the composition node. |underlines| is an optional set
- /// of ranges that will be underlined in the resulting text.
- /// |replacement_range| is an optional range of the existing text that will be
- /// replaced. |selection_range| is an optional range of the resulting text that
- /// will be selected after insertion or replacement. The |replacement_range|
- /// value is only used on OS X.
- /// This method may be called multiple times as the composition changes. When
- /// the client is done making changes the composition should either be canceled
- /// or completed. To cancel the composition call ImeCancelComposition. To
- /// complete the composition call either ImeCommitText or
- /// ImeFinishComposingText. Completion is usually signaled when:
- /// A. The client receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR
- /// flag (on Windows), or;
- /// B. The client receives a "commit" signal of GtkIMContext (on Linux), or;
- /// C. insertText of NSTextInput is called (on Mac).
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void ImeSetComposition(string text,
- int underlinesCount,
- CefCompositionUnderline underlines,
- CefRange replacementRange,
- CefRange selectionRange)
- {
- fixed (char* text_ptr = text)
- {
- cef_string_t n_text = new cef_string_t(text_ptr, text != null ? text.Length : 0);
- UIntPtr n_underlinesCount = checked((UIntPtr)underlinesCount);
- var n_underlines = underlines.ToNative();
- cef_range_t n_replacementRange = new cef_range_t(replacementRange.From, replacementRange.To);
- cef_range_t n_selectionRange = new cef_range_t(selectionRange.From, selectionRange.To);
- cef_browser_host_t.ime_set_composition(_self, &n_text, n_underlinesCount, &n_underlines, &n_replacementRange, &n_selectionRange);
- }
- }
- /// <summary>
- /// Completes the existing composition by optionally inserting the specified
- /// |text| into the composition node. |replacement_range| is an optional range
- /// of the existing text that will be replaced. |relative_cursor_pos| is where
- /// the cursor will be positioned relative to the current cursor position. See
- /// comments on ImeSetComposition for usage. The |replacement_range| and
- /// |relative_cursor_pos| values are only used on OS X.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void ImeCommitText(string text, CefRange replacementRange, int relativeCursorPos)
- {
- fixed (char* text_ptr = text)
- {
- cef_string_t n_text = new cef_string_t(text_ptr, text != null ? text.Length : 0);
- var n_replacementRange = new cef_range_t(replacementRange.From, replacementRange.To);
- cef_browser_host_t.ime_commit_text(_self, &n_text, &n_replacementRange, relativeCursorPos);
- }
- }
- /// <summary>
- /// Completes the existing composition by applying the current composition node
- /// contents. If |keep_selection| is false the current selection, if any, will
- /// be discarded. See comments on ImeSetComposition for usage.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void ImeFinishComposingText(bool keepSelection)
- {
- cef_browser_host_t.ime_finish_composing_text(_self, keepSelection ? 1 : 0);
- }
- /// <summary>
- /// Cancels the existing composition and discards the composition node
- /// contents without applying them. See comments on ImeSetComposition for
- /// usage.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void ImeCancelComposition()
- {
- cef_browser_host_t.ime_cancel_composition(_self);
- }
- /// <summary>
- /// Call this method when the user drags the mouse into the web view (before
- /// calling DragTargetDragOver/DragTargetLeave/DragTargetDrop).
- /// |drag_data| should not contain file contents as this type of data is not
- /// allowed to be dragged into the web view. File contents can be removed using
- /// CefDragData::ResetFileContents (for example, if |drag_data| comes from
- /// CefRenderHandler::StartDragging).
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragTargetDragEnter(CefDragData dragData, CefMouseEvent mouseEvent, CefDragOperationsMask allowedOps)
- {
- var n_mouseEvent = mouseEvent.ToNative();
- cef_browser_host_t.drag_target_drag_enter(_self,
- dragData.ToNative(),
- &n_mouseEvent,
- allowedOps);
- }
- /// <summary>
- /// Call this method each time the mouse is moved across the web view during
- /// a drag operation (after calling DragTargetDragEnter and before calling
- /// DragTargetDragLeave/DragTargetDrop).
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragTargetDragOver(CefMouseEvent mouseEvent, CefDragOperationsMask allowedOps)
- {
- var n_mouseEvent = mouseEvent.ToNative();
- cef_browser_host_t.drag_target_drag_over(_self, &n_mouseEvent, allowedOps);
- }
- /// <summary>
- /// Call this method when the user drags the mouse out of the web view (after
- /// calling DragTargetDragEnter).
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragTargetDragLeave()
- {
- cef_browser_host_t.drag_target_drag_leave(_self);
- }
- /// <summary>
- /// Call this method when the user completes the drag operation by dropping
- /// the object onto the web view (after calling DragTargetDragEnter).
- /// The object being dropped is |drag_data|, given as an argument to
- /// the previous DragTargetDragEnter call.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragTargetDrop(CefMouseEvent mouseEvent)
- {
- var n_mouseEvent = mouseEvent.ToNative();
- cef_browser_host_t.drag_target_drop(_self, &n_mouseEvent);
- }
- /// <summary>
- /// Call this method when the drag operation started by a
- /// CefRenderHandler::StartDragging call has ended either in a drop or
- /// by being cancelled. |x| and |y| are mouse coordinates relative to the
- /// upper-left corner of the view. If the web view is both the drag source
- /// and the drag target then all DragTarget* methods should be called before
- /// DragSource* mthods.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragSourceEndedAt(int x, int y, CefDragOperationsMask op)
- {
- cef_browser_host_t.drag_source_ended_at(_self, x, y, op);
- }
- /// <summary>
- /// Call this method when the drag operation started by a
- /// CefRenderHandler::StartDragging call has completed. This method may be
- /// called immediately without first calling DragSourceEndedAt to cancel a
- /// drag operation. If the web view is both the drag source and the drag
- /// target then all DragTarget* methods should be called before DragSource*
- /// mthods.
- /// This method is only used when window rendering is disabled.
- /// </summary>
- public void DragSourceSystemDragEnded()
- {
- cef_browser_host_t.drag_source_system_drag_ended(_self);
- }
- /// <summary>
- /// Returns the current visible navigation entry for this browser. This method
- /// can only be called on the UI thread.
- /// </summary>
- public CefNavigationEntry GetVisibleNavigationEntry()
- {
- return CefNavigationEntry.FromNativeOrNull(
- cef_browser_host_t.get_visible_navigation_entry(_self)
- );
- }
- /// <summary>
- /// Set accessibility state for all frames. |accessibility_state| may be
- /// default, enabled or disabled. If |accessibility_state| is STATE_DEFAULT
- /// then accessibility will be disabled by default and the state may be further
- /// controlled with the "force-renderer-accessibility" and
- /// "disable-renderer-accessibility" command-line switches. If
- /// |accessibility_state| is STATE_ENABLED then accessibility will be enabled.
- /// If |accessibility_state| is STATE_DISABLED then accessibility will be
- /// completely disabled.
- /// For windowed browsers accessibility will be enabled in Complete mode (which
- /// corresponds to kAccessibilityModeComplete in Chromium). In this mode all
- /// platform accessibility objects will be created and managed by Chromium's
- /// internal implementation. The client needs only to detect the screen reader
- /// and call this method appropriately. For example, on macOS the client can
- /// handle the @"AXEnhancedUserInterface" accessibility attribute to detect
- /// VoiceOver state changes and on Windows the client can handle WM_GETOBJECT
- /// with OBJID_CLIENT to detect accessibility readers.
- /// For windowless browsers accessibility will be enabled in TreeOnly mode
- /// (which corresponds to kAccessibilityModeWebContentsOnly in Chromium). In
- /// this mode renderer accessibility is enabled, the full tree is computed, and
- /// events are passed to CefAccessibiltyHandler, but platform accessibility
- /// objects are not created. The client may implement platform accessibility
- /// objects using CefAccessibiltyHandler callbacks if desired.
- /// </summary>
- public void SetAccessibilityState(CefState accessibilityState)
- {
- cef_browser_host_t.set_accessibility_state(_self, accessibilityState);
- }
- /// <summary>
- /// Enable notifications of auto resize via CefDisplayHandler::OnAutoResize.
- /// Notifications are disabled by default. |min_size| and |max_size| define the
- /// range of allowed sizes.
- /// </summary>
- public void SetAutoResizeEnabled(bool enabled, CefSize minSize, CefSize maxSize)
- {
- var nMinSize = new cef_size_t(minSize.Width, minSize.Height);
- var nMaxSize = new cef_size_t(maxSize.Width, maxSize.Height);
- cef_browser_host_t.set_auto_resize_enabled(_self, enabled ? 1 : 0, &nMinSize, &nMaxSize);
- }
- /// <summary>
- /// Returns the extension hosted in this browser or NULL if no extension is
- /// hosted. See CefRequestContext::LoadExtension for details.
- /// </summary>
- public CefExtension GetExtension()
- {
- var nExtension = cef_browser_host_t.get_extension(_self);
- return CefExtension.FromNativeOrNull(nExtension);
- }
- /// <summary>
- /// Returns true if this browser is hosting an extension background script.
- /// Background hosts do not have a window and are not displayable. See
- /// CefRequestContext::LoadExtension for details.
- /// </summary>
- public bool IsBackgroundHost
- {
- get
- {
- return cef_browser_host_t.is_background_host(_self) != 0;
- }
- }
- /// <summary>
- /// Set whether the browser's audio is muted.
- /// </summary>
- public void SetAudioMuted(bool value)
- {
- cef_browser_host_t.set_audio_muted(_self, value ? 1 : 0);
- }
- /// <summary>
- /// Returns true if the browser's audio is muted. This method can only be
- /// called on the UI thread.
- /// </summary>
- public bool IsAudioMuted
- {
- get
- {
- return cef_browser_host_t.is_audio_muted(_self) != 0;
- }
- }
- }
- }
|