Skip to main content

WebView

Struct WebView 

Source
pub struct WebView<Engine, Message>
where Engine: Engine,
{ /* private fields */ }
Expand description

The Advanced WebView widget that creates and shows webview(s).

Important: You must drive the webview with a periodic Action::Update / Action::UpdateAll subscription (e.g. via iced::time::every). Without it the webview will never render and the screen stays blank.

fn subscription(&self) -> iced::Subscription<Message> {
    iced::time::every(std::time::Duration::from_millis(16))
        .map(|_| Message::WebView(Action::UpdateAll))
}

Implementations§

Source§

impl<Engine: Engine + Default, Message: Send + Clone + 'static> WebView<Engine, Message>

Source

pub fn new() -> Self

Create new Advanced Webview widget

Source

pub fn set_scale_factor(&mut self, scale: f32)

Set the display scale factor for HiDPI rendering.

Source

pub fn on_create_view( self, on_create_view: impl Fn(usize) -> Message + 'static, ) -> Self

Subscribe to create view events

Source

pub fn on_close_view( self, on_close_view: impl Fn(usize) -> Message + 'static, ) -> Self

Subscribe to close view events

Source

pub fn on_url_change( self, on_url_change: impl Fn(ViewId, String) -> Message + 'static, ) -> Self

Subscribe to url change events

Source

pub fn on_title_change( self, on_title_change: impl Fn(ViewId, String) -> Message + 'static, ) -> Self

Subscribe to title change events

Source

pub fn on_copy(self, on_copy: impl Fn(String) -> Message + 'static) -> Self

Subscribe to copy events (text selection copied via Ctrl+C / Cmd+C)

Source

pub fn on_action( self, mapper: impl Fn(Action) -> Message + Send + Sync + 'static, ) -> Self

Provide a mapper from Action to Message so the webview can spawn async tasks that route back through the iced update loop. Required for litehtml and blitz engines — without it, URL navigation and image loading will not work.

Source

pub fn with_initial_size(self, size: Size<u32>) -> Self

Set the initial viewport size used before the first resize event. Defaults to 1920x1080.

Source

pub fn update(&mut self, action: Action) -> Task<Message>

Passes update to webview

Source

pub fn url_for(&self, id: ViewId) -> Option<&str>

Get the URL for a specific view

Source

pub fn title_for(&self, id: ViewId) -> Option<&str>

Get the title for a specific view

Source

pub fn view<'a, T: 'a>(&'a self, id: usize) -> Element<'a, Action, T>

Like a normal view() method in iced, but takes an id of the desired view

Trait Implementations§

Source§

impl<Engine: Engine + Default, Message: Send + Clone + 'static> Default for WebView<Engine, Message>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<Engine, Message> Freeze for WebView<Engine, Message>
where Engine: Freeze,

§

impl<Engine, Message> !RefUnwindSafe for WebView<Engine, Message>

§

impl<Engine, Message> !Send for WebView<Engine, Message>

§

impl<Engine, Message> !Sync for WebView<Engine, Message>

§

impl<Engine, Message> Unpin for WebView<Engine, Message>
where Engine: Unpin,

§

impl<Engine, Message> UnsafeUnpin for WebView<Engine, Message>
where Engine: UnsafeUnpin,

§

impl<Engine, Message> !UnwindSafe for WebView<Engine, Message>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T