Struct moxie_dom::elements::embedding::IframeBuilder[][src]

#[must_use = "needs to be built"]pub struct IframeBuilder { /* fields omitted */ }

The HTML Inline Frame element (<iframe>) represents a nested browsing context, embedding another HTML page into the current one.

A type for initializing the element’s attributes before calling build.


impl IframeBuilder[src]

pub fn allow(self, to_set: impl ToString) -> Self[src]

Specifies a feature policy for the <iframe>.

pub fn height(self, to_set: impl ToString) -> Self[src]

The height of the frame in CSS pixels. Default is 150.

pub fn name(self, to_set: impl ToString) -> Self[src]

A targetable name for the embedded browsing context. This can be used in the target attribute of the <a>, <form>, or <base> elements; the formtarget attribute of the <input> or <button> elements; or the windowName parameter in the method.

pub fn referrerpolicy(self, to_set: ReferrerPolicy) -> Self[src]

Indicates which referrer to send when fetching the frame’s resource.

pub fn sandbox(self, to_set: impl ToString) -> Self[src]

Applies extra restrictions to the content in the frame. The value of the attribute can either be empty to apply all restrictions, or space-separated tokens to lift particular restrictions:

  • allow-downloads-without-user-activation: Allows for downloads to occur without a gesture from the user.
  • allow-forms: Allows the resource to submit forms. If this keyword is not used, form submission is blocked.
  • allow-modals: Lets the resource open modal windows.
  • allow-orientation-lock: Lets the resource lock the screen orientation.
  • allow-pointer-lock: Lets the resource use the Pointer Lock API.
  • allow-popups: Allows popups (such as, target=“_blank”, or showModalDialog()). If this keyword is not used, the popup will silently fail to open.
  • allow-popups-to-escape-sandbox: Lets the sandboxed document open new windows without those windows inheriting the sandboxing. For example, this can safely sandbox an advertisement without forcing the same restrictions upon the page the ad links to.
  • allow-presentation: Lets the resource start a presentation session.
  • allow-same-origin: If this token is not used, the resource is treated as being from a special origin that always fails the same-origin policy.
  • allow-scripts: Lets the resource run scripts (but not create popup windows).
  • allow-storage-access-by-user-activation : Lets the resource request access to the parent’s storage capabilities with the Storage Access API.
  • allow-top-navigation: Lets the resource navigate the top-level browsing context (the one named _top).
  • allow-top-navigation-by-user-activation: Lets the resource navigate the top-level browsing context, but only if initiated by a user gesture.

Notes about sandboxing:

When the embedded document has the same origin as the embedding page, it is strongly discouraged to use both allow-scripts and allow-same-origin, as that lets the embedded document remove the sandbox attribute — making it no more secure than not using the sandbox attribute at all.

Sandboxing is useless if the attacker can display content outside a sandboxed iframe — such as if the viewer opens the frame in a new tab. Such content should be also served from a separate origin to limit potential damage.

pub fn src(self, to_set: impl ToString) -> Self[src]

The URL of the page to embed. Use a value of about:blank to embed an empty page that conforms to the same-origin policy. Also note that programatically removing an <iframe>’s src attribute (e.g. via Element.removeAttribute()) causes about:blank to be loaded in the frame in Firefox (from version 65), Chromium-based browsers, and Safari/iOS.

pub fn srcdoc(self, to_set: impl ToString) -> Self[src]

Inline HTML to embed, overriding the src attribute. If a browser does not support the srcdoc attribute, it will fall back to the URL in the src attribute.

pub fn width(self, to_set: impl ToString) -> Self[src]

The width of the frame in CSS pixels. Default is 300.

Trait Implementations

impl ElementBuilder for IframeBuilder[src]

impl<E> EventTarget<E> for IframeBuilder where
    E: GlobalEvent

impl GlobalEventHandler for IframeBuilder[src]

impl HtmlElementBuilder for IframeBuilder[src]

impl NodeBuilder for IframeBuilder[src]

type Output = Iframe

The type of the DOM node

fn build(self) -> Iframe[src]

Initialize the element with all of the attributes so far.

impl NodeWrapper for IframeBuilder[src]

Auto Trait Implementations

impl !RefUnwindSafe for IframeBuilder

impl !Send for IframeBuilder

impl !Sync for IframeBuilder

impl Unpin for IframeBuilder

impl !UnwindSafe for IframeBuilder

Blanket Implementations

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

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

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

impl<N> Child for N where
    N: NodeWrapper

impl<T> Downcast for T where
    T: Any

impl<T> Erased for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.