Enum EmbedderMsg

pub enum EmbedderMsg {
    Status(WebViewId, Option<String>),
    ChangePageTitle(WebViewId, Option<String>),
    MoveTo(WebViewId, Point2D<i32, DevicePixel>),
    ResizeTo(WebViewId, Size2D<i32, DevicePixel>),
    ShowSimpleDialog(WebViewId, SimpleDialog),
    RequestAuthentication(WebViewId, ServoUrl, bool, IpcSender<Option<AuthenticationResponse>>),
    ShowContextMenu(WebViewId, IpcSender<ContextMenuResult>, Option<String>, Vec<String>),
    AllowNavigationRequest(WebViewId, PipelineId, ServoUrl),
    AllowOpeningWebView(WebViewId, IpcSender<Option<(WebViewId, ViewportDetails)>>),
    WebViewClosed(WebViewId),
    WebViewFocused(WebViewId),
    WebViewBlurred,
    AllowUnload(WebViewId, IpcSender<AllowOrDeny>),
    Keyboard(WebViewId, KeyboardEvent),
    ClearClipboard(WebViewId),
    GetClipboardText(WebViewId, IpcSender<Result<String, String>>),
    SetClipboardText(WebViewId, String),
    SetCursor(WebViewId, Cursor),
    NewFavicon(WebViewId, ServoUrl),
    HistoryChanged(WebViewId, Vec<ServoUrl>, usize),
    NotifyFullscreenStateChanged(WebViewId, bool),
    NotifyLoadStatusChanged(WebViewId, LoadStatus),
    WebResourceRequested(Option<WebViewId>, WebResourceRequest, IpcSender<WebResourceResponseMsg>),
    Panic(WebViewId, String, Option<String>),
    GetSelectedBluetoothDevice(WebViewId, Vec<String>, IpcSender<Option<String>>),
    SelectFiles(WebViewId, Vec<FilterPattern>, bool, IpcSender<Option<Vec<PathBuf>>>),
    PromptPermission(WebViewId, PermissionFeature, IpcSender<AllowOrDeny>),
    ShowIME(WebViewId, InputMethodType, Option<(String, i32)>, bool, Box2D<i32, DevicePixel>),
    HideIME(WebViewId),
    ReportProfile(Vec<u8>),
    MediaSessionEvent(WebViewId, MediaSessionEvent),
    OnDevtoolsStarted(Result<u16, ()>, String),
    RequestDevtoolsConnection(IpcSender<AllowOrDeny>),
    PlayGamepadHapticEffect(WebViewId, usize, GamepadHapticEffectType, IpcSender<bool>),
    StopGamepadHapticEffect(WebViewId, usize, IpcSender<bool>),
    ShutdownComplete,
    ShowNotification(Option<WebViewId>, Notification),
    ShowSelectElementMenu(WebViewId, Vec<SelectElementOptionOrOptgroup>, Option<usize>, Box2D<i32, DevicePixel>, IpcSender<Option<usize>>),
}

Variants

Status(WebViewId, Option<String>)

A status message to be displayed by the browser chrome.

ChangePageTitle(WebViewId, Option<String>)

Alerts the embedder that the current page has changed its title.

MoveTo(WebViewId, Point2D<i32, DevicePixel>)

Move the window to a point

ResizeTo(WebViewId, Size2D<i32, DevicePixel>)

Resize the window to size

ShowSimpleDialog(WebViewId, SimpleDialog)

Show the user a simple dialog (alert(), confirm(), or prompt()). Since their messages are controlled by web content, they should be presented to the user in a way that makes them impossible to mistake for browser UI.

RequestAuthentication(WebViewId, ServoUrl, bool, IpcSender<Option<AuthenticationResponse>>)

Request authentication for a load or navigation from the embedder.

ShowContextMenu(WebViewId, IpcSender<ContextMenuResult>, Option<String>, Vec<String>)

Show a context menu to the user

AllowNavigationRequest(WebViewId, PipelineId, ServoUrl)

Whether or not to allow a pipeline to load a url.

AllowOpeningWebView(WebViewId, IpcSender<Option<(WebViewId, ViewportDetails)>>)

Whether or not to allow script to open a new tab/browser

WebViewClosed(WebViewId)

A webview was destroyed.

WebViewFocused(WebViewId)

A webview gained focus for keyboard events.

WebViewBlurred

All webviews lost focus for keyboard events.

AllowUnload(WebViewId, IpcSender<AllowOrDeny>)

Wether or not to unload a document

Keyboard(WebViewId, KeyboardEvent)

Sends an unconsumed key event back to the embedder.

ClearClipboard(WebViewId)

Inform embedder to clear the clipboard

GetClipboardText(WebViewId, IpcSender<Result<String, String>>)

Gets system clipboard contents

SetClipboardText(WebViewId, String)

Sets system clipboard contents

SetCursor(WebViewId, Cursor)

Changes the cursor.

NewFavicon(WebViewId, ServoUrl)

A favicon was detected

HistoryChanged(WebViewId, Vec<ServoUrl>, usize)

The history state has changed.

NotifyFullscreenStateChanged(WebViewId, bool)

Entered or exited fullscreen.

NotifyLoadStatusChanged(WebViewId, LoadStatus)

The LoadStatus of the Given WebView has changed.

WebResourceRequested(Option<WebViewId>, WebResourceRequest, IpcSender<WebResourceResponseMsg>)

Panic(WebViewId, String, Option<String>)

A pipeline panicked. First string is the reason, second one is the backtrace.

GetSelectedBluetoothDevice(WebViewId, Vec<String>, IpcSender<Option<String>>)

Open dialog to select bluetooth device.

SelectFiles(WebViewId, Vec<FilterPattern>, bool, IpcSender<Option<Vec<PathBuf>>>)

Open file dialog to select files. Set boolean flag to true allows to select multiple files.

PromptPermission(WebViewId, PermissionFeature, IpcSender<AllowOrDeny>)

Open interface to request permission specified by prompt.

ShowIME(WebViewId, InputMethodType, Option<(String, i32)>, bool, Box2D<i32, DevicePixel>)

Request to present an IME to the user when an editable element is focused. If the input is text, the second parameter defines the pre-existing string text content and the zero-based index into the string locating the insertion point. bool is true for multi-line and false otherwise.

HideIME(WebViewId)

Request to hide the IME when the editable element is blurred.

ReportProfile(Vec<u8>)

Report a complete sampled profile

MediaSessionEvent(WebViewId, MediaSessionEvent)

Notifies the embedder about media session events (i.e. when there is metadata for the active media session, playback state changes…).

OnDevtoolsStarted(Result<u16, ()>, String)

Report the status of Devtools Server with a token that can be used to bypass the permission prompt.

RequestDevtoolsConnection(IpcSender<AllowOrDeny>)

Ask the user to allow a devtools client to connect.

PlayGamepadHapticEffect(WebViewId, usize, GamepadHapticEffectType, IpcSender<bool>)

Request to play a haptic effect on a connected gamepad.

StopGamepadHapticEffect(WebViewId, usize, IpcSender<bool>)

Request to stop a haptic effect on a connected gamepad.

ShutdownComplete

Informs the embedder that the constellation has completed shutdown. Required because the constellation can have pending calls to make (e.g. SetFrameTree) at the time that we send it an ExitMsg.

ShowNotification(Option<WebViewId>, Notification)

Request to display a notification.

ShowSelectElementMenu(WebViewId, Vec<SelectElementOptionOrOptgroup>, Option<usize>, Box2D<i32, DevicePixel>, IpcSender<Option<usize>>)

Indicates that the user has activated a <select> element.

The embedder should respond with the new state of the <select> element.

Trait Implementations

impl Debug for EmbedderMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbedderMsg

fn deserialize<__D>( __deserializer: __D, ) -> Result<EmbedderMsg, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'_derivative_strum> From<&'_derivative_strum EmbedderMsg> for &'static str

fn from(x: &'_derivative_strum EmbedderMsg) -> &'static str

Converts to this type from the input type.

impl From<EmbedderMsg> for &'static str

fn from(x: EmbedderMsg) -> &'static str

Converts to this type from the input type.

impl Serialize for EmbedderMsg

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.