Skip to main content

DocumentOverlayHandler

Struct DocumentOverlayHandler 

Source
pub(crate) struct DocumentOverlayHandler {
    document: Dom<Document>,
    fullscreen_element: MutNullableDom<Element>,
    top_layer: DomRefCell<Vec<Dom<Element>>>,
    pending_top_layer_removals: DomRefCell<Vec<Dom<Element>>>,
    topmost_modal: MutNullableDom<Element>,
    open_dialogs_list: DomRefCell<Vec<Dom<HTMLDialogElement>>>,
    dialog_pointerdown_target: MutNullableDom<HTMLDialogElement>,
}
Expand description

The DocumentOverlayHandler is a structure responsible for overlays for the [crate::Document] and storing data related to overlays. It exists to decrease the size of the [crate::Document] structure.

Fields§

§document: Dom<Document>

The Document this DocumentOverlayHandler belongs to.

§fullscreen_element: MutNullableDom<Element>

Entry node for fullscreen.

§top_layer: DomRefCell<Vec<Dom<Element>>>§pending_top_layer_removals: DomRefCell<Vec<Dom<Element>>>§topmost_modal: MutNullableDom<Element>§open_dialogs_list: DomRefCell<Vec<Dom<HTMLDialogElement>>>§dialog_pointerdown_target: MutNullableDom<HTMLDialogElement>

Implementations§

Source§

impl DocumentOverlayHandler

Source

pub(crate) fn new(document: &Document) -> Self

Source

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

Source

pub(crate) fn set_fullscreen_element(&self, element: Option<&Element>)

Source

pub(crate) fn fully_exit_fullscreen(&self, cx: &mut JSContext)

Source

pub(crate) fn enter_fullscreen( &self, cx: &mut CurrentRealm<'_>, pending: &Element, ) -> RootedPromise

Source

pub(crate) fn exit_fullscreen(&self, cx: &mut JSContext) -> RootedPromise

Source

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

Source

pub(crate) fn open_dialogs_list_contains( &self, dialog: &HTMLDialogElement, ) -> bool

Source

pub(crate) fn add_to_open_dialogs_list( &self, dialog: &HTMLDialogElement, no_gc: &NoGC, )

Source

pub(crate) fn remove_from_open_dialogs_list( &self, dialog: &HTMLDialogElement, no_gc: &NoGC, )

Source

pub(crate) fn topmost_open_dialog(&self) -> Option<DomRoot<HTMLDialogElement>>

Source

pub(crate) fn dialog_pointerdown_target( &self, ) -> Option<DomRoot<HTMLDialogElement>>

Source

pub(crate) fn set_dialog_pointerdown_target( &self, dialog: Option<&HTMLDialogElement>, )

Source

pub(crate) fn top_layer_contains(&self, element: &Element) -> bool

Source

fn pending_top_layer_removals_contains(&self, element: &Element) -> bool

Source

pub(crate) fn is_in_the_top_layer(&self, element: &Element) -> bool

Source

pub(crate) fn add_an_element_to_the_top_layer( &self, element: &Element, no_gc: &NoGC, )

Source

pub(crate) fn request_an_element_to_be_removed_from_the_top_layer( &self, element: &Element, no_gc: &NoGC, )

Source

pub(crate) fn remove_an_element_from_the_top_layer_immediately( &self, element: &Element, no_gc: &NoGC, )

Source

pub(crate) fn process_top_layer_removals(&self, cx: &mut JSContext)

Source

pub fn update_topmost_modal(&self, no_gc: &NoGC)

Source

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

Trait Implementations§

Source§

impl MallocSizeOf for DocumentOverlayHandler

Source§

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.
Source§

impl Traceable for DocumentOverlayHandler

Source§

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

Trace self.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

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<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> MaybeBoxed<Box<T>> for T

Source§

fn maybe_boxed(self) -> Box<T>

Convert
Source§

impl<T> MaybeBoxed<T> for T

Source§

fn maybe_boxed(self) -> T

Convert
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<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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<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