Struct WebView 

pub struct WebView { /* private fields */ }

An embeddable web view. Composing widget: it delegates layout/paint to a style-built overlay and drives a native engine subview on top.

See the crate docs for the dormancy/visibility contract.

Implementations

impl WebView

pub fn new() -> Self

A blank web view. Set content with url / html / source.

pub fn url(self, url: impl Into<String>) -> Self

Navigate to a URL on first open.

pub fn html(self, html: impl Into<String>) -> Self

Load inline HTML on first open.

pub fn source(self, source: WebSource) -> Self

Set the initial content from a WebSource.

pub fn user_agent(self, ua: impl Into<String>) -> Self

Override the engine User-Agent.

pub fn transparent(self, transparent: bool) -> Self

Request a transparent engine background.

pub fn devtools(self, devtools: bool) -> Self

Enable engine devtools (debug builds, by convention).

pub fn custom_protocol(self, scheme: impl Into<String>) -> Self

Register a custom-protocol scheme name ("app" → app://). The dispatch closure lives app-side; the backend only needs the name.

pub fn url_signal(self, signal: Signal<String>) -> Self

Two-way URL binding. The engine writes the resolved URL into signal when an in-page navigation completes; calling signal.set("…") externally drives programmatic navigation (equivalent to load_url). The engine’s own echo is filtered, so the two directions don’t loop.

The initial page still comes from url / html / source; url_signal governs navigation after the first load (the signal’s value at build time is taken as the baseline and does not trigger a navigation).

pub fn title_signal(self, signal: Signal<String>) -> Self

Bind the page title (read-only — updated on TitleChanged).

pub fn loading_signal(self, signal: Signal<bool>) -> Self

Bind the loading flag (read-only — true between page-load start/finish).

pub fn on_message( self, cb: impl FnMut(String, &mut EventContext<'_>) + 'static, ) -> Self

JS → Rust: called when the page runs window.ipc.postMessage(...).

pub fn on_title_changed( self, cb: impl FnMut(String, &mut EventContext<'_>) + 'static, ) -> Self

Called when the document title changes.

pub fn on_navigation( self, cb: impl FnMut(NavigationInfo, &mut EventContext<'_>) + 'static, ) -> Self

Called when a navigation starts (observer — see NavigationInfo; it cannot veto). Useful for URL-bar sync before the load completes.

pub fn on_page_load( self, cb: impl FnMut(PageLoadState, &mut EventContext<'_>) + 'static, ) -> Self

Called when page loading starts and finishes (see PageLoadState).

pub fn on_download_started( self, cb: impl FnMut(DownloadStart, &mut EventContext<'_>) + 'static, ) -> Self

Called when the page begins a download (see DownloadStart).

pub fn on_download_finished( self, cb: impl FnMut(DownloadOutcome, &mut EventContext<'_>) + 'static, ) -> Self

Called when a download finishes or fails (see DownloadOutcome).

pub fn style(self, style: impl WebViewStyle) -> Self

Per-call style override (highest precedence).

pub fn enter_page_on_focus(self, enter: bool) -> Self

Enter the page as soon as the frame receives keyboard focus, rather than on Enter (the default two-step).

Only appropriate when the web view is the window’s content and there is nothing else in the Tab cycle worth reaching — a kiosk view, a full-window document preview. In a mixed UI it makes Tab a one-way door: once the engine owns the keyboard, Teksilo sees no more keys and getting back out is up to the engine and the OS. Off by default for exactly that reason.

pub fn input_mode(self, input: WebViewInput) -> Self

Declare who owns pointer input over the page’s rectangle.

WebViewInput::Native — the default — gives it to the engine; WebViewInput::Transparent keeps it for Teksilo. See WebViewInput for everything the choice decides.

pub fn page_focused_signal(&self) -> Signal<bool>

Whether the page currently holds the engine’s keyboard focus.

Written from WebViewEvent::EngineFocusChanged, which is the only thing that can know: once the native subview owns the keyboard, the toolkit is told nothing more about what happens inside it. Distinct from focused_signal, which reports Teksilo’s own focus on the frame.

pub fn focus_page(&self)

Hand keyboard focus to the engine subview, entering the page.

The programmatic form of the frame’s Enter key. No-op before the engine has opened (the handle is created post-mount).

pub fn focused_signal(&self) -> Signal<bool>

Whether the Teksilo-side frame currently holds keyboard focus.

True while Tab has landed on the web view; it says nothing about whether the page has been entered, because once the engine subview owns the keyboard the toolkit is no longer told what happens inside it.

pub fn id(&self) -> WebViewId

The stable routing identity of this web view.

pub fn load_url(&self, url: &str)

Navigate to url.

pub fn post_message(&self, msg: &str)

Rust → JS: dispatch a teksilo-message event carrying msg.

pub fn eval(&self, script: &str)

Evaluate JavaScript in the page.

pub fn reload(&self)

Reload the page.

pub fn go_back(&self)

Navigate back.

pub fn go_forward(&self)

Navigate forward.

pub fn stop(&self)

Stop the current load.

pub fn open_devtools(&self)

Open the engine’s developer tools (no-op where unsupported, e.g. Servo).

pub fn close_devtools(&self)

Close the engine’s developer tools.

Trait Implementations

impl Debug for WebView

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

Formats the value using the given formatter.

impl Default for WebView

fn default() -> Self

Returns the “default value” for a type.

impl Drop for WebView

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Widget for WebView

fn build(&mut self, ctx: &mut BuildContext<'_>) -> Vec<WidgetId>

Compose child widgets. Called once after the widget is placed in the arena, and again whenever the widget is marked for rebuild — a BindingLevel::Rebuild binding, rebuild_single_widget, or a density switch. A theme or locale switch does not rebuild: set_theme and set_locale mark layout + paint dirty and leave the built subtree standing, so anything derived from the theme or the locale must be read per pass or bound to a signal rather than captured here. Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

fn layout_response( &self, proposal: SizeProposal, ctx: &LayoutContext<'_>, ) -> LayoutResponse

Respond to the parent’s size proposal with this widget’s wanted size, grow/shrink weights, and compression floor (see LayoutResponse).

fn place_children( &self, bounds: Rect, _proposal: SizeProposal, children: &mut [WidgetPlacement], ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

fn wants_after_paint(&self) -> bool

Whether this widget wants its after_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t aggregate descendant geometry.

fn after_paint(&self, view: &WidgetTreeView<'_>, _ctx: &PaintContext<'_>)

Called once per frame after this widget’s subtree has finished painting. Receives a read-only view of the layout-resolved arena so a parent can read its descendants’ final bounds — e.g. TitleBar aggregates its drag region and control-button rects into a single HitRegions payload for the Windows backend’s WM_NCHITTEST.

fn accessibility(&self, builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

fn children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

fn as_any_mut(&mut self) -> Option<&mut dyn Any>

Mutable counterpart of as_any. Default returns None; widgets that want to expose mutable state to tests (e.g. so a test can mutate a Scene inside a SceneView post-layout) override with Some(self). Should follow the same opt-in pattern as as_any: only widgets that opt into & introspection should opt into &mut.

fn type_name(&self) -> &'static str

Concrete type name of this widget (e.g. "teksilo_widgets::button::Button"). The default implementation resolves at the impl site via std::any::type_name::<Self>(), so calls through &dyn Widget correctly dispatch to the monomorphized fn for the concrete type — getting the concrete name through the vtable without per-impl boilerplate.

fn cacheable_layout(&self) -> bool

Whether this widget’s layout_response may be memoized by the per-pass layout cache. Defaults to true.

fn paint(&self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

fn wants_post_paint(&self) -> bool

Whether this widget wants its post_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t draw a foreground over their children.

fn post_paint( &self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>, )

Draw a foreground layer over this widget’s children.

fn wants_descendant_redirects(&self) -> bool

Whether this widget wants the AT walker to consult its a11y_redirect_descendant hook for every descendant during AT tree emission, not just its direct arena children.

fn culls_children(&self) -> bool

Whether this widget decides, on every layout pass, which of its children exist at all.

fn a11y_redirect_descendant( &self, _self_id: WidgetId, _descendant: WidgetId, ) -> Option<NodeId>

Optional redirection hook for AT-tree placement of a child.

fn accessible_title_hint(&self) -> Option<String>

Suggest an accessible title to an enclosing container that wraps this widget as content — typically a modal / dialog shell that wants to propagate the inner content’s visible title as the shell’s own accessible name.

fn accessible_title_node(&self) -> Option<WidgetId>

The widget that paints this one’s title, when it has one.

fn initial_focus_hint(&self) -> Option<WidgetId>

Optional hint that directs initial focus to a specific descendant when this widget is the root of a deferred-built modal surface.

fn context_menu_key_target(&self) -> Option<WidgetId>

Which descendant a keyboard request for a context menu should target.

fn accessibility_children(&self) -> Option<Vec<WidgetId>>

Optional override for the child ORDER presented to assistive technology, when it must differ from the paint / z-order child order returned by children.

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

Downcast hook. Default implementation returns None; concrete widgets override with Some(self) when they want to expose their concrete type to test-level introspection or reflection. The trait already bounds on std::any::Any so concrete types satisfy the 'static requirement.

fn clips_children(&self) -> bool

Whether this widget clips its children to its bounds.

fn focus_reveal_rect(&self, _bounds: Rect) -> Option<Rect>

The rectangle (in absolute tree coordinates) that best represents this widget when the framework reveals it into an ancestor scroll area on focus gain. Returning None (the default) reveals the widget’s whole bounds — correct for most controls.

fn hit_shape(&self, _local_point: Point, _bounds: Rect) -> bool

Whether the point lies inside this widget’s actual shape, not just its rectangular bounds. Consulted by hit-testing right after the bounds check: returning false for a point that is inside the bounding box makes the widget transparent to the click there, so it falls through to whatever sibling is painted underneath (the same machinery as a fully pass-through node, but shape-aware).

fn accepts_child_hit(&self, _child: WidgetId, _point: Point) -> bool

Veto a hit on one of this widget’s direct children, per point.

fn hit_outset(&self, _kind: PointerKind, _tokens: &InputTokens) -> EdgeInsets

How far outside its own bounds this widget still absorbs a press, per edge, for the pointer that is asking.

fn hit_slop(&self, _kind: PointerKind, _tokens: &InputTokens) -> Option<HitSlop>

This widget’s own say in the miss-only slop pass, overriding the density default for its node.

fn hit_distance(&self, local_point: Point, bounds: Rect) -> Option<f32>

How far a missed press is from this widget’s actual silhouette, in the widget’s own bounds space.

fn target_regions(&self, _bounds: Rect) -> Vec<TargetRegion>

The interactive sub-regions this widget paints inside its own single node — a scroll bar’s thumb, a slider’s knob, a header cell’s filter affordance.

fn preserves_children_on_rebuild(&self) -> bool

How rebuild_single_widget treats this widget’s existing children when re-running its build().

fn tooltip_has_content(&self) -> bool

Whether this widget, used as tooltip content, currently has anything worth showing.

fn declare_shortcuts(&self) -> Vec<Shortcut>

Declare the rebindable keyboard shortcuts this widget exposes, without installing handlers. The framework calls this at arena insertion time (before build()) and at certain lazy boundaries (e.g. Switcher walks declarations on its not-yet-mounted Pending slots), so settings UIs and the ShortcutRegistry see the keystrokes the moment the owning container mounts — even if build() hasn’t run.

fn take_handler_set(&mut self) -> Option<HandlerSet>

Extract attached handler set from a WidgetWithHandlers wrapper. Called during arena insertion to transfer handlers to the WidgetNode. Default: returns None (no attached handlers).