Struct WebView 

pub struct WebView { /* private fields */ }

The fundamental type to present a WebView.

WebViewBuilder / WebView are the basic building blocks to construct WebView contents and scripts for those who prefer to control fine grained window creation and event handling. WebView presents the actual WebView window and let you still able to perform actions on it.

Implementations

impl WebView

pub fn id(&self) -> WebViewId<'_>

Returns the id of this webview.

pub fn url(&self) -> Result<String>

Get the current url of the webview

pub fn evaluate_script(&self, js: &str) -> Result<()>

Evaluate and run javascript code.

pub fn evaluate_script_with_callback( &self, js: &str, callback: impl Fn(String) + Send + 'static, ) -> Result<()>

Evaluate and run javascript code with callback function. The evaluation result will be serialized into a JSON string and passed to the callback function.

Exception is ignored because of the limitation on windows. You can catch it yourself and return as string as a workaround.

pub fn print(&self) -> Result<()>

Launch print modal for the webview content.

pub fn cookies_for_url(&self, url: &str) -> Result<Vec<Cookie<'static>>>

Get a list of cookies for specific url.

pub fn cookies(&self) -> Result<Vec<Cookie<'static>>>

Get the list of cookies.

Platform-specific

• Android: Unsupported, always returns an empty Vec.

pub fn set_cookie(&self, cookie: &Cookie<'_>) -> Result<()>

Set a cookie for the webview.

Platform-specific

• Android: Not supported.

pub fn delete_cookie(&self, cookie: &Cookie<'_>) -> Result<()>

Delete a cookie for the webview.

Platform-specific

• Android: Not supported.

pub fn open_devtools(&self)

Available on debug-assertions enabled or crate feature devtools only.

Open the web inspector which is usually called dev tool.

Platform-specific

• Android / iOS: Not supported.

pub fn close_devtools(&self)

Available on debug-assertions enabled or crate feature devtools only.

Close the web inspector which is usually called dev tool.

Platform-specific

• Windows / Android / iOS: Not supported.

pub fn is_devtools_open(&self) -> bool

Available on debug-assertions enabled or crate feature devtools only.

Gets the devtool window’s current visibility state.

Platform-specific

• Windows / Android / iOS: Not supported.

pub fn zoom(&self, scale_factor: f64) -> Result<()>

Set the webview zoom level

Platform-specific:

• Android: Not supported.
• macOS: available on macOS 11+ only.
• iOS: available on iOS 14+ only.

pub fn set_background_color(&self, background_color: RGBA) -> Result<()>

Specify the webview background color.

The color uses the RGBA format.

Platform-specific:

• macOS: Disables the default white WKWebView background via the drawsBackground KVC key (same as the transparent feature) and sets underPageBackgroundColor (macOS 12+) for overscroll areas.
• Windows:
  • On Windows 7, transparency is not supported and the alpha value will be ignored.
  • On Windows higher than 7: translucent colors are not supported so any alpha value other than 0 will be replaced by 255

pub fn load_url(&self, url: &str) -> Result<()>

Navigate to the specified url

pub fn reload(&self) -> Result<()>

Reloads the current page.

pub fn go_forward(&self) -> Result<()>

Go to the next page.

pub fn go_back(&self) -> Result<()>

Go to the previous page.

pub fn can_go_forward(&self) -> Result<bool>

pub fn can_go_back(&self) -> Result<bool>

pub fn load_url_with_headers(&self, url: &str, headers: HeaderMap) -> Result<()>

Navigate to the specified url using the specified headers

pub fn load_html(&self, html: &str) -> Result<()>

Load html content into the webview

pub fn clear_all_browsing_data(&self) -> Result<()>

Clear all browsing data

pub fn bounds(&self) -> Result<Rect>

pub fn set_bounds(&self, bounds: Rect) -> Result<()>

Set the webview bounds.

This is only effective if the webview was created as a child or created using WebViewBuilderExtUnix::build_gtk with gtk::Fixed.

pub fn set_visible(&self, visible: bool) -> Result<()>

Shows or hides the webview.

pub fn focus(&self) -> Result<()>

Try moving focus to the webview.

pub fn focus_parent(&self) -> Result<()>

Try moving focus away from the webview back to the parent window.

Platform-specific:

• Android: Not implemented.

Trait Implementations

impl WebViewExtUnix for WebView

Available on gtk only.

fn new_gtk<W>(widget: &W) -> Result<Self>

where W: IsA<Container>,

Create the webview inside a GTK container widget, such as GTK window.

fn webview(&self) -> WebView

Returns Webkit2gtk Webview handle

fn reparent<W>(&self, widget: &W) -> Result<()>

where W: IsA<Container>,

Attaches this webview to the given Widget and removes it from the current one.