script::dom::window

Struct Window

#[repr(C)]
pub(crate) struct Window {Show 57 fields
    globalscope: GlobalScope,
    webview_id: WebViewId,
    script_chan: Sender<MainThreadScriptMsg>,
    layout: RefCell<Box<dyn Layout>>,
    font_context: Arc<FontContext>,
    navigator: MutNullableDom<Navigator>,
    image_cache: Arc<dyn ImageCache>,
    image_cache_sender: IpcSender<PendingImageResponse>,
    window_proxy: MutNullableDom<WindowProxy>,
    document: MutNullableDom<Document>,
    location: MutNullableDom<Location>,
    history: MutNullableDom<History>,
    custom_element_registry: MutNullableDom<CustomElementRegistry>,
    performance: MutNullableDom<Performance>,
    navigation_start: Cell<CrossProcessInstant>,
    screen: MutNullableDom<Screen>,
    session_storage: MutNullableDom<Storage>,
    local_storage: MutNullableDom<Storage>,
    status: DomRefCell<DOMString>,
    trusted_types: MutNullableDom<TrustedTypePolicyFactory>,
    devtools_markers: DomRefCell<HashSet<TimelineMarkerType>>,
    devtools_marker_sender: DomRefCell<Option<IpcSender<Option<TimelineMarker>>>>,
    unhandled_resize_event: DomRefCell<Option<(ViewportDetails, WindowSizeType)>>,
    theme: Cell<PrefersColorScheme>,
    parent_info: Option<PipelineId>,
    dom_static: GlobalStaticData,
    js_runtime: DomRefCell<Option<Rc<Runtime>>>,
    viewport_details: Cell<ViewportDetails>,
    bluetooth_thread: IpcSender<BluetoothRequest>,
    bluetooth_extra_permission_data: BluetoothExtraPermissionData,
    page_clip_rect: Cell<Rect<Au>>,
    layout_blocker: Cell<LayoutBlocker>,
    webdriver_script_chan: DomRefCell<Option<IpcSender<WebDriverJSResult>>>,
    current_state: Cell<WindowState>,
    current_viewport: Cell<Rect<Au>>,
    error_reporter: CSSErrorReporter,
    scroll_offsets: DomRefCell<HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>>>,
    media_query_lists: DOMTracker<MediaQueryList>,
    test_runner: MutNullableDom<TestRunner>,
    webgl_chan: Option<WebGLChan>,
    webxr_registry: Option<Registry>,
    pending_image_callbacks: DomRefCell<HashMap<PendingImageId, Vec<PendingImageCallback>>>,
    pending_layout_images: DomRefCell<HashMapTracedValues<PendingImageId, Vec<Dom<Node>>>>,
    unminified_css_dir: DomRefCell<Option<String>>,
    local_script_source: Option<String>,
    test_worklet: MutNullableDom<Worklet>,
    paint_worklet: MutNullableDom<Worklet>,
    exists_mut_observer: Cell<bool>,
    compositor_api: CrossProcessCompositorApi,
    has_sent_idle_message: Cell<bool>,
    relayout_event: bool,
    unminify_css: bool,
    user_content_manager: UserContentManager,
    player_context: WindowGLContext,
    throttled: Cell<bool>,
    layout_marker: DomRefCell<Rc<Cell<bool>>>,
    current_event: DomRefCell<Option<Dom<Event>>>,
}

Fields§

§globalscope: GlobalScope§webview_id: WebViewId

The webview that contains this Window.

This may not be the top-level Window, in the case of frames.

§script_chan: Sender<MainThreadScriptMsg>§layout: RefCell<Box<dyn Layout>>§font_context: Arc<FontContext>

A FontContext which is used to store and match against fonts for this Window and to trigger the download of web fonts.

§navigator: MutNullableDom<Navigator>§image_cache: Arc<dyn ImageCache>§image_cache_sender: IpcSender<PendingImageResponse>§window_proxy: MutNullableDom<WindowProxy>§document: MutNullableDom<Document>§location: MutNullableDom<Location>§history: MutNullableDom<History>§custom_element_registry: MutNullableDom<CustomElementRegistry>§performance: MutNullableDom<Performance>§navigation_start: Cell<CrossProcessInstant>§screen: MutNullableDom<Screen>§session_storage: MutNullableDom<Storage>§local_storage: MutNullableDom<Storage>§status: DomRefCell<DOMString>§trusted_types: MutNullableDom<TrustedTypePolicyFactory>§devtools_markers: DomRefCell<HashSet<TimelineMarkerType>>

For sending timeline markers. Will be ignored if no devtools server

§devtools_marker_sender: DomRefCell<Option<IpcSender<Option<TimelineMarker>>>>§unhandled_resize_event: DomRefCell<Option<(ViewportDetails, WindowSizeType)>>

Most recent unhandled resize event, if any.

§theme: Cell<PrefersColorScheme>

Platform theme.

§parent_info: Option<PipelineId>

Parent id associated with this page, if any.

§dom_static: GlobalStaticData

Global static data related to the DOM.

§js_runtime: DomRefCell<Option<Rc<Runtime>>>

The JavaScript runtime.

§viewport_details: Cell<ViewportDetails>

The ViewportDetails of this Window’s frame.

§bluetooth_thread: IpcSender<BluetoothRequest>

A handle for communicating messages to the bluetooth thread.

§bluetooth_extra_permission_data: BluetoothExtraPermissionData§page_clip_rect: Cell<Rect<Au>>

An enlarged rectangle around the page contents visible in the viewport, used to prevent creating display list items for content that is far away from the viewport.

§layout_blocker: Cell<LayoutBlocker>

See the documentation for LayoutBlocker. Essentially, this flag prevents layouts from happening before the first load event, apart from a few exceptional cases.

§webdriver_script_chan: DomRefCell<Option<IpcSender<WebDriverJSResult>>>

A channel for communicating results of async scripts back to the webdriver server

§current_state: Cell<WindowState>

The current state of the window object

§current_viewport: Cell<Rect<Au>>§error_reporter: CSSErrorReporter§scroll_offsets: DomRefCell<HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>>>

A list of scroll offsets for each scrollable element.

§media_query_lists: DOMTracker<MediaQueryList>

All the MediaQueryLists we need to update

§test_runner: MutNullableDom<TestRunner>§webgl_chan: Option<WebGLChan>

A handle for communicating messages to the WebGL thread, if available.

§webxr_registry: Option<Registry>§pending_image_callbacks: DomRefCell<HashMap<PendingImageId, Vec<PendingImageCallback>>>

When an element triggers an image load or starts watching an image load from the ImageCache it adds an entry to this list. When those loads are triggered from layout, they also add an etry to Self::pending_layout_images.

§pending_layout_images: DomRefCell<HashMapTracedValues<PendingImageId, Vec<Dom<Node>>>>

All of the elements that have an outstanding image request that was initiated by layout during a reflow. They are stored in the script thread to ensure that the element can be marked dirty when the image data becomes available at some point in the future.

§unminified_css_dir: DomRefCell<Option<String>>

Directory to store unminified css for this window if unminify-css opt is enabled.

§local_script_source: Option<String>

Directory with stored unminified scripts

§test_worklet: MutNullableDom<Worklet>

Worklets

§paint_worklet: MutNullableDom<Worklet>

https://drafts.css-houdini.org/css-paint-api-1/#paint-worklet

§exists_mut_observer: Cell<bool>

Flag to identify whether mutation observers are present(true)/absent(false)

§compositor_api: CrossProcessCompositorApi

Cross-process access to the compositor.

§has_sent_idle_message: Cell<bool>

Indicate whether a SetDocumentStatus message has been sent after a reflow is complete. It is used to avoid sending idle message more than once, which is unneccessary.

§relayout_event: bool

Emits notifications when there is a relayout.

§unminify_css: bool

Unminify Css.

§user_content_manager: UserContentManager

User content manager

§player_context: WindowGLContext

Window’s GL context from application

§throttled: Cell<bool>§layout_marker: DomRefCell<Rc<Cell<bool>>>

A shared marker for the validity of any cached layout values. A value of true indicates that any such values remain valid; any new layout that invalidates those values will cause the marker to be set to false.

§current_event: DomRefCell<Option<Dom<Event>>>

Struct WindowCopy item path

Fields§

Implementations§

impl Window

fn __assert_parent_type(&self)

impl Window

pub(crate) fn webview_id(&self) -> WebViewId

pub(crate) fn as_global_scope(&self) -> &GlobalScope

pub(crate) fn layout(&self) -> Ref<'_, Box<dyn Layout>>

pub(crate) fn layout_mut(&self) -> RefMut<'_, Box<dyn Layout>>

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

pub(crate) fn set_exists_mut_observer(&self)

pub(crate) fn clear_js_runtime_for_script_deallocation(&self)

pub(crate) fn discard_browsing_context(&self)

pub(crate) fn time_profiler_chan(&self) -> &TimeProfilerChan

pub(crate) fn origin(&self) -> &MutableOrigin

pub(crate) fn get_cx(&self) -> JSContext

pub(crate) fn get_js_runtime(&self) -> Ref<'_, Option<Rc<Runtime>>>

pub(crate) fn main_thread_script_chan(&self) -> &Sender<MainThreadScriptMsg>

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

pub(crate) fn new_script_pair( &self, ) -> (ScriptEventLoopSender, ScriptEventLoopReceiver)

pub(crate) fn event_loop_sender(&self) -> ScriptEventLoopSender

pub(crate) fn image_cache(&self) -> Arc<dyn ImageCache>

pub(crate) fn window_proxy(&self) -> DomRoot<WindowProxy>

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

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

pub(crate) fn bluetooth_thread(&self) -> IpcSender<BluetoothRequest>

pub(crate) fn bluetooth_extra_permission_data( &self, ) -> &BluetoothExtraPermissionData

pub(crate) fn css_error_reporter(&self) -> Option<&dyn ParseErrorReporter>

pub(crate) fn set_scroll_offsets( &self, offsets: HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>>, )

pub(crate) fn current_viewport(&self) -> UntypedRect<Au>

pub(crate) fn webgl_chan(&self) -> Option<WebGLCommandSender>

pub(crate) fn webxr_registry(&self) -> Option<Registry>

fn new_paint_worklet(&self, can_gc: CanGc) -> DomRoot<Worklet>

pub(crate) fn register_image_cache_listener( &self, id: PendingImageId, callback: impl Fn(PendingImageResponse) + 'static, ) -> IpcSender<PendingImageResponse>

fn pending_layout_image_notification(&self, response: PendingImageResponse)

pub(crate) fn pending_image_notification(&self, response: PendingImageResponse)

pub(crate) fn compositor_api(&self) -> &CrossProcessCompositorApi

pub(crate) fn userscripts(&self) -> &[UserScript]

pub(crate) fn get_player_context(&self) -> WindowGLContext

pub(crate) fn dispatch_event_with_target_override( &self, event: &Event, can_gc: CanGc, ) -> EventStatus

pub(crate) fn font_context(&self) -> &Arc<FontContext>

impl Window

pub(crate) fn create_named_properties_object( cx: JSContext, proto: HandleObject<'_>, object: MutableHandleObject<'_>, )

pub(crate) fn current_event(&self) -> Option<DomRoot<Event>>

pub(crate) fn set_current_event( &self, event: Option<&Event>, ) -> Option<DomRoot<Event>>

fn post_message_impl( &self, target_origin: &USVString, source_origin: ImmutableOrigin, source: &Window, cx: JSContext, message: HandleValue<'_>, transfer: CustomAutoRooterGuard<'_, Vec<*mut JSObject>>, ) -> ErrorResult

pub(crate) fn paint_worklet(&self) -> DomRoot<Worklet>

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

pub(crate) fn clear_js_runtime(&self)

pub(crate) fn scroll( &self, x_: f64, y_: f64, behavior: ScrollBehavior, can_gc: CanGc, )

pub(crate) fn perform_a_scroll( &self, x: f32, y: f32, scroll_id: ExternalScrollId, _behavior: ScrollBehavior, _element: Option<&Element>, can_gc: CanGc, )

pub(crate) fn update_viewport_for_scroll(&self, x: f32, y: f32)

pub(crate) fn device_pixel_ratio(&self) -> Scale<f32, CSSPixel, DevicePixel>

fn client_window(&self) -> (Size2D<u32, CSSPixel>, Point2D<i32, CSSPixel>)

pub(crate) fn advance_animation_clock(&self, delta_ms: i32)

fn force_reflow( &self, reflow_goal: ReflowGoal, condition: Option<ReflowTriggerCondition>, ) -> bool

pub(crate) fn reflow(&self, reflow_goal: ReflowGoal, can_gc: CanGc) -> bool

pub(crate) fn reflow_if_reflow_timer_expired(&self, can_gc: CanGc)

pub(crate) fn prevent_layout_until_load_event(&self)

pub(crate) fn allow_layout_if_necessary(&self, can_gc: CanGc)

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

pub(crate) fn update_constellation_epoch(&self)

pub(crate) fn layout_reflow(&self, query_msg: QueryMsg, can_gc: CanGc) -> bool

pub(crate) fn resolved_font_style_query( &self, node: &Node, value: String, can_gc: CanGc, ) -> Option<ServoArc<Font>>

pub(crate) fn content_box_query_unchecked( &self, node: &Node, ) -> Option<UntypedRect<Au>>

pub(crate) fn content_box_query( &self, node: &Node, can_gc: CanGc, ) -> Option<UntypedRect<Au>>

pub(crate) fn content_boxes_query( &self, node: &Node, can_gc: CanGc, ) -> Vec<UntypedRect<Au>>

pub(crate) fn client_rect_query( &self, node: &Node, can_gc: CanGc, ) -> UntypedRect<i32>

pub(crate) fn scrolling_area_query( &self, node: Option<&Node>, can_gc: CanGc, ) -> UntypedRect<i32>

pub(crate) fn scroll_offset_query( &self, node: &Node, ) -> Vector2D<f32, LayoutPixel>

pub(crate) fn scroll_node( &self, node: &Node, x_: f64, y_: f64, behavior: ScrollBehavior, can_gc: CanGc, )

pub(crate) fn resolved_style_query( &self, element: TrustedNodeAddress, pseudo: Option<PseudoElement>, property: PropertyId, can_gc: CanGc, ) -> DOMString

pub(crate) fn get_iframe_viewport_details_if_known( &self, browsing_context_id: BrowsingContextId, can_gc: CanGc, ) -> Option<ViewportDetails>

pub(crate) fn offset_parent_query( &self, node: &Node, can_gc: CanGc, ) -> (Option<DomRoot<Element>>, UntypedRect<Au>)

pub(crate) fn text_index_query( &self, node: &Node, point_in_node: UntypedPoint2D<f32>, can_gc: CanGc, ) -> Option<usize>

pub(crate) fn init_window_proxy(&self, window_proxy: &WindowProxy)

pub(crate) fn init_document(&self, document: &Document)

pub(crate) fn load_url( &self, history_handling: NavigationHistoryBehavior, force_reload: bool, load_data: LoadData, can_gc: CanGc, )

pub(crate) fn set_viewport_details(&self, size: ViewportDetails)

Struct Window

pub(crate) fn cache_layout_value<T>(&self, value: T) -> LayoutValue<T>
where T: Copy + MallocSizeOf,

fn is<T>(&self) -> bool
where T: DerivedFrom<Self>,

fn upcast<T>(&self) -> &T
where T: Castable, Self: DerivedFrom<T>,

fn downcast<T>(&self) -> Option<&T>
where T: DerivedFrom<Self>,