1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT
use crate::ffi;
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// Message that can be sent between the UI process and web process extensions.
///
/// A WebKitUserMessage is a message that can be used for the communication between the UI process
/// and web process extensions. A WebKitUserMessage always has a name, and it can also include parameters and
/// UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all web process extensions,
/// from a web process extension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its
/// corresponding #WebKitWebPage (and vice versa). One to one messages can be replied to directly with
/// webkit_user_message_send_reply().
///
/// ## Properties
///
///
/// #### `fd-list`
/// The UNIX file descriptors of the user message.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `name`
/// The name of the user message.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `parameters`
/// The parameters of the user message as a #GVariant, or [`None`]
/// if the message doesn't include parameters. Note that only complete types are
/// allowed.
///
/// Readable | Writeable | Construct Only
#[doc(alias = "WebKitUserMessage")]
pub struct UserMessage(Object<ffi::WebKitUserMessage, ffi::WebKitUserMessageClass>);
match fn {
type_ => || ffi::webkit_user_message_get_type(),
}
}
impl UserMessage {
/// Create a new #WebKitUserMessage with @name.
/// ## `name`
/// the message name
/// ## `parameters`
/// the message parameters as a #GVariant, or [`None`]
///
/// # Returns
///
/// the newly created #WebKitUserMessage object.
#[doc(alias = "webkit_user_message_new")]
pub fn new(name: &str, parameters: Option<&glib::Variant>) -> UserMessage {
assert_initialized_main_thread!();
unsafe {
from_glib_none(ffi::webkit_user_message_new(
name.to_glib_none().0,
parameters.to_glib_none().0,
))
}
}
/// Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent.
/// ## `name`
/// the message name
/// ## `parameters`
/// the message parameters as a #GVariant
/// ## `fd_list`
/// the message file descriptors
///
/// # Returns
///
/// the newly created #WebKitUserMessage object.
#[doc(alias = "webkit_user_message_new_with_fd_list")]
#[doc(alias = "new_with_fd_list")]
pub fn with_fd_list(
name: &str,
parameters: Option<&glib::Variant>,
fd_list: Option<&impl IsA<gio::UnixFDList>>,
) -> UserMessage {
assert_initialized_main_thread!();
unsafe {
from_glib_none(ffi::webkit_user_message_new_with_fd_list(
name.to_glib_none().0,
parameters.to_glib_none().0,
fd_list.map(|p| p.as_ref()).to_glib_none().0,
))
}
}
/// Get the @self list of file descritpor.
///
/// # Returns
///
/// the message list of file descriptors
#[doc(alias = "webkit_user_message_get_fd_list")]
#[doc(alias = "get_fd_list")]
#[doc(alias = "fd-list")]
pub fn fd_list(&self) -> Option<gio::UnixFDList> {
unsafe { from_glib_none(ffi::webkit_user_message_get_fd_list(self.to_glib_none().0)) }
}
/// Get the @self name.
///
/// # Returns
///
/// the message name
#[doc(alias = "webkit_user_message_get_name")]
#[doc(alias = "get_name")]
pub fn name(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::webkit_user_message_get_name(self.to_glib_none().0)) }
}
/// Get the @self parameters.
///
/// # Returns
///
/// the message parameters
#[doc(alias = "webkit_user_message_get_parameters")]
#[doc(alias = "get_parameters")]
pub fn parameters(&self) -> Option<glib::Variant> {
unsafe {
from_glib_none(ffi::webkit_user_message_get_parameters(
self.to_glib_none().0,
))
}
}
/// Send a reply to an user message.
///
/// If @reply is floating, it's consumed.
/// You can only send a reply to a #WebKitUserMessage that has been
/// received.
/// ## `reply`
/// a #WebKitUserMessage to send as reply
#[doc(alias = "webkit_user_message_send_reply")]
pub fn send_reply(&self, reply: &UserMessage) {
unsafe {
ffi::webkit_user_message_send_reply(self.to_glib_none().0, reply.to_glib_none().0);
}
}
/// Gets the quark for the domain of user message errors.
///
/// # Returns
///
/// user message error domain.
#[doc(alias = "webkit_user_message_error_quark")]
pub fn error_quark() -> glib::Quark {
assert_initialized_main_thread!();
unsafe { from_glib(ffi::webkit_user_message_error_quark()) }
}
}