dioxus_lib::prelude

Struct MountedData

source
pub struct MountedData { /* private fields */ }
Expand description

An Element that has been rendered and allows reading and modifying information about it.

Different platforms will have different implementations and different levels of support for this trait. Renderers that do not support specific features will return None for those queries.

Implementations§

source§

impl MountedData

source

pub fn new(registry: impl RenderedElementBacking + 'static) -> MountedData

Create a new MountedData

source

pub async fn get_scroll_offset( &self, ) -> Result<Vector2D<f64, Pixels>, MountedError>

Get the number of pixels that an element’s content is scrolled

source

pub async fn get_scroll_size(&self) -> Result<Size2D<f64, Pixels>, MountedError>

Get the size of an element’s content, including content not visible on the screen due to overflow

source

pub async fn get_client_rect(&self) -> Result<Rect<f64, Pixels>, MountedError>

Get the bounding rectangle of the element relative to the viewport (this does not include the scroll position)

source

pub fn scroll_to( &self, behavior: ScrollBehavior, ) -> Pin<Box<dyn Future<Output = Result<(), MountedError>>>>

Scroll to make the element visible

source

pub fn set_focus( &self, focus: bool, ) -> Pin<Box<dyn Future<Output = Result<(), MountedError>>>>

Set the focus on the element

source

pub fn downcast<T>(&self) -> Option<&T>
where T: 'static,

Downcast this event to a concrete event type

Trait Implementations§

source§

impl Debug for MountedData

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&PlatformEventData> for MountedData

source§

fn from(val: &PlatformEventData) -> MountedData

Converts to this type from the input type.
source§

impl<E> From<E> for MountedData

source§

fn from(e: E) -> MountedData

Converts to this type from the input type.

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<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> InitializeFromFunction<T> for T

source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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<Ret> SpawnIfAsync<(), Ret> for Ret

source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

source§

fn super_from(input: T) -> O

Convert from a type to another type.
source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

source§

fn super_into(self) -> O

Convert from a type to another type.
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> 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