Struct ul_next::overlay::Overlay

source ·
pub struct Overlay { /* private fields */ }
Expand description

Web-content overlay. Displays a web-page within an area of the main window.

Each Overlay is essentially a View and an on-screen quad. You should create the Overlay then load content into the underlying View.

Can be created with Window::create_overlay or Window::create_overlay_with_view.

Implementations§

source§

impl Overlay

source

pub fn view(&self) -> &View

Get the underlying View.

source

pub fn width(&self) -> u32

Get the width (in pixels).

source

pub fn height(&self) -> u32

Get the height (in pixels).

source

pub fn x(&self) -> i32

Get the x-position (offset from the left of the Window), in pixels.

source

pub fn y(&self) -> i32

Get the y-position (offset from the top of the Window), in pixels.

source

pub fn is_hidden(&self) -> bool

Whether or not the overlay is hidden (not drawn).

source

pub fn show(&self)

Show the overlay.

source

pub fn hide(&self)

Hide the overlay (will no longer be drawn)

source

pub fn has_focus(&self) -> bool

Whether or not this overlay has keyboard focus.

source

pub fn focus(&self)

Grant this overlay exclusive keyboard focus.

source

pub fn unfocus(&self)

Remove keyboard focus.

source

pub fn move_to(&self, x: i32, y: i32)

Move the overlay to a new position (in pixels).

source

pub fn resize(&self, width: u32, height: u32)

Resize the overlay (and underlying View), dimensions should be specified in pixels.

Trait Implementations§

source§

impl Drop for Overlay

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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, 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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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.