Struct WebView

pub struct WebView(Rc<RefCell<WebViewInner>>);

A handle to a Servo webview. If you clone this handle, it does not create a new webview, but instead creates a new handle to the webview. Once the last handle is dropped, Servo considers that the webview has closed and will clean up all associated resources related to this webview.

Rendering Model

Every WebView has a RenderingContext. The embedder manages when the contents of the WebView paint to the RenderingContext. When a WebView needs to be painted, for instance, because its contents have changed, Servo will call WebViewDelegate::notify_new_frame_ready in order to signal that it is time to repaint the WebView using WebView::paint.

An example of how this flow might work is:

1. WebViewDelegate::notify_new_frame_ready is called. The applications triggers a request to repaint the window that contains this WebView.
2. During window repainting, the application calls WebView::paint and the contents of the RenderingContext are updated.
3. If the RenderingContext is double-buffered, the application then calls crate::RenderingContext::present() in order to swap the back buffer to the front, finally displaying the updated WebView contents.

In cases where the WebView contents have not been updated, but a repaint is necessary, for instance when repainting a window due to damage, an application may simply perform the final two steps and Servo will repaint even without first calling the WebViewDelegate::notify_new_frame_ready method.

Tuple Fields

0: Rc<RefCell<WebViewInner>>

Implementations

impl WebView

pub(crate) fn new( constellation_proxy: &ConstellationProxy, compositor: Rc<RefCell<IOCompositor>>, ) -> Self

fn inner(&self) -> Ref<'_, WebViewInner>

fn inner_mut(&self) -> RefMut<'_, WebViewInner>

pub(crate) fn from_weak_handle( inner: &Weak<RefCell<WebViewInner>>, ) -> Option<Self>

pub(crate) fn weak_handle(&self) -> Weak<RefCell<WebViewInner>>

pub fn delegate(&self) -> Rc<dyn WebViewDelegate>

pub fn set_delegate(&self, delegate: Rc<dyn WebViewDelegate>)

pub fn clipboard_delegate(&self) -> Rc<dyn ClipboardDelegate>

pub fn set_clipboard_delegate(&self, delegate: Rc<dyn ClipboardDelegate>)

pub fn id(&self) -> WebViewId

pub fn load_status(&self) -> LoadStatus

pub(crate) fn set_load_status(self, new_value: LoadStatus)

pub fn url(&self) -> Option<Url>

pub(crate) fn set_url(self, new_value: Url)

pub fn status_text(&self) -> Option<String>

pub(crate) fn set_status_text(self, new_value: Option<String>)

pub fn page_title(&self) -> Option<String>

pub(crate) fn set_page_title(self, new_value: Option<String>)

pub fn favicon_url(&self) -> Option<Url>

pub(crate) fn set_favicon_url(self, new_value: Url)

pub fn focused(&self) -> bool

pub(crate) fn set_focused(self, new_value: bool)

pub fn cursor(&self) -> Cursor

pub(crate) fn set_cursor(self, new_value: Cursor)

pub fn focus(&self)

pub fn blur(&self)

pub fn rect(&self) -> DeviceRect

pub fn move_resize(&self, rect: DeviceRect)

pub fn show(&self, hide_others: bool)

pub fn hide(&self)

pub fn raise_to_top(&self, hide_others: bool)

pub fn notify_theme_change(&self, theme: Theme)

pub fn load(&self, url: Url)

pub fn reload(&self)

pub fn go_back(&self, amount: usize)

pub fn go_forward(&self, amount: usize)

pub fn notify_scroll_event( &self, location: ScrollLocation, point: DeviceIntPoint, touch_event_action: TouchEventType, )

pub fn notify_input_event(&self, event: InputEvent)

pub fn notify_media_session_action_event(&self, event: MediaSessionActionType)

pub fn notify_vsync(&self)

pub fn resize(&self, new_size: PhysicalSize<u32>)

pub fn set_zoom(&self, new_zoom: f32)

pub fn reset_zoom(&self)

pub fn set_pinch_zoom(&self, new_pinch_zoom: f32)

pub fn exit_fullscreen(&self)

pub fn set_throttled(&self, throttled: bool)

pub fn toggle_webrender_debugging(&self, debugging: WebRenderDebugOption)

pub fn capture_webrender(&self)

pub fn toggle_sampling_profiler(&self, rate: Duration, max_duration: Duration)

pub fn send_error(&self, message: String)

pub fn paint(&self) -> bool

Paint the contents of this WebView into its RenderingContext. This will always paint, unless the Opts::wait_for_stable_image option is enabled. In that case, this might do nothing. Returns true if a paint was actually performed.

Trait Implementations

impl Clone for WebView

fn clone(&self) -> WebView

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Hash for WebView

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WebView

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.