Gui

Struct Gui 

Source
pub struct Gui {
    rendering_context: Rc<OffscreenRenderingContext>,
    context: EguiGlow,
    event_queue: Vec<UserInterfaceCommand>,
    toolbar_height: Length<f32, DeviceIndependentPixel>,
    last_mouse_position: Option<Point2D<f32, DeviceIndependentPixel>>,
    location: String,
    location_dirty: bool,
    load_status: LoadStatus,
    status_text: Option<String>,
    can_go_back: bool,
    can_go_forward: bool,
    favicon_textures: HashMap<WebViewId, (TextureHandle, SizedTexture)>,
}
Expand description

The user interface of a headed servoshell. Currently this is implemented via egui.

Fields§

§rendering_context: Rc<OffscreenRenderingContext>§context: EguiGlow§event_queue: Vec<UserInterfaceCommand>§toolbar_height: Length<f32, DeviceIndependentPixel>§last_mouse_position: Option<Point2D<f32, DeviceIndependentPixel>>§location: String§location_dirty: bool

Whether the location has been edited by the user without clicking Go.

§load_status: LoadStatus

The LoadStatus of the active WebView.

§status_text: Option<String>

The text to display in the status bar on the bottom of the window.

§can_go_back: bool

Whether or not the current WebView can navigate backward.

§can_go_forward: bool

Whether or not the current WebView can navigate forward.

§favicon_textures: HashMap<WebViewId, (TextureHandle, SizedTexture)>

Handle to the GPU texture of the favicon.

These need to be cached across egui draw calls.

Implementations§

Source§

impl Gui

Source

pub(crate) fn new( winit_window: &Window, event_loop: &ActiveEventLoop, event_loop_proxy: EventLoopProxy<AppEvent>, rendering_context: Rc<OffscreenRenderingContext>, initial_url: Url, ) -> Self

Source

pub(crate) fn take_user_interface_commands( &mut self, ) -> Vec<UserInterfaceCommand>

Source

pub(crate) fn on_window_event( &mut self, winit_window: &Window, event: &WindowEvent, ) -> EventResponse

Source

pub(crate) fn toolbar_height(&self) -> Length<f32, DeviceIndependentPixel>

The height of the top toolbar of this user inteface ie the distance from the top of the window to the position of the WebView.

Source

fn is_in_egui_toolbar_rect( &self, position: Point2D<f32, DeviceIndependentPixel>, ) -> bool

Return true iff the given position is over the egui toolbar.

Source

fn toolbar_button(text: &str) -> Button<'_>

Create a frameless button with square sizing, as used in the toolbar.

Source

fn browser_tab( ui: &mut Ui, window: &ServoShellWindow, webview: WebView, event_queue: &mut Vec<UserInterfaceCommand>, favicon_texture: Option<SizedTexture>, )

Draws a browser tab, checking for clicks and queues appropriate UserInterfaceCommands. Using a custom widget here would’ve been nice, but it doesn’t seem as though egui supports that, so we arrange multiple Widgets in a way that they look connected.

Source

pub(crate) fn update( &mut self, state: &RunningAppState, window: &ServoShellWindow, headed_window: &Window, )

Update the user interface, but do not paint the updated state.

Source

pub(crate) fn paint(&mut self, window: &Window)

Paint the GUI, as of the last update.

Source

fn update_location_in_toolbar(&mut self, window: &ServoShellWindow) -> bool

Updates the location field from the given RunningAppState, unless the user has started editing it without clicking Go, returning true iff it has changed (needing an egui update).

Source

fn update_load_status(&mut self, window: &ServoShellWindow) -> bool

Source

fn update_status_text(&mut self, window: &ServoShellWindow) -> bool

Source

fn update_can_go_back_and_forward(&mut self, window: &ServoShellWindow) -> bool

Source

pub(crate) fn update_webview_data(&mut self, window: &ServoShellWindow) -> bool

Updates all fields taken from the given ServoShellWindow, such as the location field. Returns true iff the egui needs an update.

Source

pub(crate) fn handle_accesskit_event(&mut self, event: &WindowEvent) -> bool

Returns true if a redraw is required after handling the provided event.

Source

pub(crate) fn set_zoom_factor(&self, factor: f32)

Trait Implementations§

Source§

impl Drop for Gui

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Gui

§

impl !RefUnwindSafe for Gui

§

impl !Send for Gui

§

impl !Sync for Gui

§

impl Unpin for Gui

§

impl !UnwindSafe for Gui

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

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

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Filterable for T

Source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
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> 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(value: T, _simd: S) -> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

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

Source§

impl<T> MaybeSendSync for T