Struct WindowProxy

#[repr(C)]
pub(crate) struct WindowProxy {

    reflector: Reflector,
    browsing_context_id: BrowsingContextId,
    opener: Option<BrowsingContextId>,
    top_level_browsing_context_id: TopLevelBrowsingContextId,
    name: DomRefCell<DOMString>,
    currently_active: Cell<Option<PipelineId>>,
    discarded: Cell<bool>,
    disowned: Cell<bool>,
    is_closing: Cell<bool>,
    frame_element: Option<Dom<Element>>,
    parent: Option<Dom<WindowProxy>>,
    delaying_load_events_mode: Cell<bool>,
    creator_base_url: Option<ServoUrl>,
    creator_url: Option<ServoUrl>,
    creator_origin: Option<ImmutableOrigin>,
}

Fields

reflector: Reflector

The JS WindowProxy object. Unlike other reflectors, we mutate this field because we have to brain-transplant the reflector when the WindowProxy changes Window.

browsing_context_id: BrowsingContextId

The id of the browsing context. In the case that this is a nested browsing context, this is the id of the container.

opener: Option<BrowsingContextId>

top_level_browsing_context_id: TopLevelBrowsingContextId

The frame id of the top-level ancestor browsing context. In the case that this is a top-level window, this is our id.

name: DomRefCell<DOMString>

The name of the browsing context (sometimes, but not always, equal to the name of a container element)

currently_active: Cell<Option<PipelineId>>

The pipeline id of the currently active document. May be None, when the currently active document is in another script thread. We do not try to keep the pipeline id for documents in other threads, as this would require the constellation notifying many script threads about the change, which could be expensive.

discarded: Cell<bool>

Has the browsing context been discarded?

disowned: Cell<bool>

Has the browsing context been disowned?

is_closing: Cell<bool>

https://html.spec.whatwg.org/multipage/#is-closing

frame_element: Option<Dom<Element>>

The containing iframe element, if this is a same-origin iframe

parent: Option<Dom<WindowProxy>>

The parent browsing context’s window proxy, if this is a nested browsing context

delaying_load_events_mode: Cell<bool>

https://html.spec.whatwg.org/multipage/#delaying-load-events-mode

creator_base_url: Option<ServoUrl>

The creator browsing context’s base url.

creator_url: Option<ServoUrl>

The creator browsing context’s url.

creator_origin: Option<ImmutableOrigin>

The creator browsing context’s origin.

Implementations

impl WindowProxy

fn new_inherited( browsing_context_id: BrowsingContextId, top_level_browsing_context_id: TopLevelBrowsingContextId, currently_active: Option<PipelineId>, frame_element: Option<&Element>, parent: Option<&WindowProxy>, opener: Option<BrowsingContextId>, creator: CreatorBrowsingContextInfo, ) -> WindowProxy

pub(crate) fn new( window: &Window, browsing_context_id: BrowsingContextId, top_level_browsing_context_id: TopLevelBrowsingContextId, frame_element: Option<&Element>, parent: Option<&WindowProxy>, opener: Option<BrowsingContextId>, creator: CreatorBrowsingContextInfo, ) -> Root<Dom<WindowProxy>>

pub(crate) fn new_dissimilar_origin( global_to_clone_from: &GlobalScope, browsing_context_id: BrowsingContextId, top_level_browsing_context_id: TopLevelBrowsingContextId, parent: Option<&WindowProxy>, opener: Option<BrowsingContextId>, creator: CreatorBrowsingContextInfo, ) -> Root<Dom<WindowProxy>>

fn create_auxiliary_browsing_context( &self, name: DOMString, noopener: bool, ) -> Option<Root<Dom<WindowProxy>>>

pub(crate) fn is_delaying_load_events_mode(&self) -> bool

https://html.spec.whatwg.org/multipage/#delaying-load-events-mode

pub(crate) fn start_delaying_load_events_mode(&self)

https://html.spec.whatwg.org/multipage/#delaying-load-events-mode

pub(crate) fn stop_delaying_load_events_mode(&self)

https://html.spec.whatwg.org/multipage/#delaying-load-events-mode

pub(crate) fn disown(&self)

pub(crate) fn close(&self)

https://html.spec.whatwg.org/multipage/#dom-window-close Step 3.1, set BCs is_closing to true.

pub(crate) fn is_closing(&self) -> bool

https://html.spec.whatwg.org/multipage/#is-closing

pub(crate) fn creator_base_url(&self) -> Option<ServoUrl>

https://html.spec.whatwg.org/multipage/#creator-base-url

pub(crate) fn has_creator_base_url(&self) -> bool

pub(crate) fn creator_url(&self) -> Option<ServoUrl>

https://html.spec.whatwg.org/multipage/#creator-url

pub(crate) fn has_creator_url(&self) -> bool

pub(crate) fn creator_origin(&self) -> Option<ImmutableOrigin>

https://html.spec.whatwg.org/multipage/#creator-origin

pub(crate) fn has_creator_origin(&self) -> bool

pub(crate) fn opener( &self, cx: *mut JSContext, in_realm_proof: InRealm<'_>, retval: MutableHandleValue<'_>, )

pub(crate) fn open( &self, url: USVString, target: DOMString, features: DOMString, can_gc: CanGc, ) -> Result<Option<Root<Dom<WindowProxy>>>, Error>

pub(crate) fn choose_browsing_context( &self, name: DOMString, noopener: bool, ) -> (Option<Root<Dom<WindowProxy>>>, bool)

pub(crate) fn is_auxiliary(&self) -> bool

pub(crate) fn discard_browsing_context(&self)

pub(crate) fn is_browsing_context_discarded(&self) -> bool

pub(crate) fn browsing_context_id(&self) -> BrowsingContextId

pub(crate) fn top_level_browsing_context_id(&self) -> TopLevelBrowsingContextId

pub(crate) fn frame_element(&self) -> Option<&Element>

pub(crate) fn document(&self) -> Option<Root<Dom<Document>>>

pub(crate) fn parent(&self) -> Option<&WindowProxy>

pub(crate) fn top(&self) -> &WindowProxy

fn set_window(&self, window: &GlobalScope, handler: &WindowProxyHandler)

Change the Window that this WindowProxy resolves to.

pub(crate) fn set_currently_active(&self, window: &Window)

pub(crate) fn unset_currently_active(&self)

pub(crate) fn currently_active(&self) -> Option<PipelineId>

pub(crate) fn get_name(&self) -> DOMString

pub(crate) fn set_name(&self, name: DOMString)

Trait Implementations

impl DomObject for WindowProxy

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the GlobalScope of the realm that the DomObject was created in. If this object is a Node, this will be different from it’s owning Document if adopted by. For Nodes it’s almost always better to use NodeTraits::owning_global.

impl HasParent for WindowProxy

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl MallocSizeOf for WindowProxy

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for WindowProxy

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for WindowProxy

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.

impl ToJSValConvertible for WindowProxy

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for WindowProxy

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl Eq for WindowProxy