Struct cacao::webview::WebView

pub struct WebView<T = ()> {

    pub is_handle: bool,
    pub objc: ObjcProperty,
    pub layer: Layer,
    pub objc_delegate: Option<ShareId<Object>>,
    pub delegate: Option<Box<T>>,
    pub top: LayoutAnchorY,
    pub leading: LayoutAnchorX,
    pub left: LayoutAnchorX,
    pub trailing: LayoutAnchorX,
    pub right: LayoutAnchorX,
    pub bottom: LayoutAnchorY,
    pub width: LayoutAnchorDimension,
    pub height: LayoutAnchorDimension,
    pub center_x: LayoutAnchorX,
    pub center_y: LayoutAnchorY,
}

Available on crate feature webview only.

Fields

is_handle: bool

An internal flag for whether an instance of a View is a handle. Typically, there’s only one instance that should have this set to false - if that one drops, we need to know to do some extra cleanup.

objc: ObjcProperty

A pointer to the Objective-C runtime view controller.

layer: Layer

A reference to the underlying CALayer.

objc_delegate: Option<ShareId<Object>>

We need to store the underlying delegate separately from the WKWebView - this is a where we do so.

delegate: Option<Box<T>>

A pointer to the delegate for this view.

top: LayoutAnchorY

A pointer to the Objective-C runtime top layout constraint.

leading: LayoutAnchorX

A pointer to the Objective-C runtime leading layout constraint.

left: LayoutAnchorX

A pointer to the Objective-C runtime left layout constraint.

trailing: LayoutAnchorX

A pointer to the Objective-C runtime trailing layout constraint.

right: LayoutAnchorX

A pointer to the Objective-C runtime right layout constraint.

bottom: LayoutAnchorY

A pointer to the Objective-C runtime bottom layout constraint.

width: LayoutAnchorDimension

A pointer to the Objective-C runtime width layout constraint.

height: LayoutAnchorDimension

A pointer to the Objective-C runtime height layout constraint.

center_x: LayoutAnchorX

A pointer to the Objective-C runtime center X layout constraint.

center_y: LayoutAnchorY

A pointer to the Objective-C runtime center Y layout constraint.

Implementations

impl WebView

pub fn new(config: WebViewConfig) -> Self

Returns a default WebView, suitable for customizing and displaying.

impl<T> WebView<T> where
    T: WebViewDelegate + 'static, 

pub fn with(config: WebViewConfig, delegate: T) -> WebView<T>

Initializes a new WebView with a given WebViewDelegate. This enables you to respond to events and customize the view as a module, similar to class-based systems.

impl<T> WebView<T>

pub fn load_url(&self, url: &str)

Given a URL, instructs the WebView to load it.

pub fn load_html(&self, html_string: &str)

Given a HTML string, instructs the WebView to load it. Useful for small html files, but often better to use custom protocol.

pub fn go_back(&self)

Go back in history, if possible.

pub fn go_forward(&self)

Go forward in history, if possible.

Trait Implementations

impl<T> Debug for WebView<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebView

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for WebView<T>

fn drop(&mut self)

A bit of extra cleanup for delegate callback pointers.

impl<T> Layout for WebView<T>

fn add_subview<V: Layout>(&self, _: &V)

Currently, this is a noop. Theoretically there is reason to support this, but in practice I’ve never seen it needed… but am open to discussion.

fn set_needs_display(&self, needs_display: bool)

Sets whether this needs to be redrawn before being displayed.

fn remove_from_superview(&self)

Removes a control or view from the superview.

fn set_frame<R: Into<CGRect>>(&self, rect: R)

Sets the frame for the view this trait is applied to.

fn set_translates_autoresizing_mask_into_constraints(&self, translates: bool)

Sets whether the view for this trait should translate autoresizing masks into layout constraints.

fn set_hidden(&self, hide: bool)

Sets whether the view for this is hidden or not.

fn is_hidden(&self) -> bool

Returns whether this is hidden or not.

fn is_hidden_or_ancestor_is_hidden(&self) -> bool

Returns whether this is hidden, or whether an ancestor view is hidden.

fn register_for_dragged_types(&self, types: &[PasteboardType])

Register this view for drag and drop operations.

fn unregister_dragged_types(&self)

Unregisters this as a target for drag and drop operations.

fn set_posts_frame_change_notifications(&self, posts: bool)

Sets whether this posts notifications when the frame rectangle changes.

fn set_posts_bounds_change_notifications(&self, posts: bool)

Sets whether this posts notifications when the bounds rectangle changes.

fn set_alpha(&self, value: f64)

Theoretically this belongs elsewhere, but we want to enable this on all view layers, since it’s common enough anyway.