Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/browser/nsIWebBrowserChrome.idl
//
/// `interface nsIWebBrowserChrome : nsISupports`
///
/// ```text
/// /**
/// * nsIWebBrowserChrome corresponds to the top-level, outermost window
/// * containing an embedded Gecko web browser.
/// */
/// ```
///
// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.
#[repr(C)]
pub struct nsIWebBrowserChrome {
vtable: &'static nsIWebBrowserChromeVTable,
/// This field is a phantomdata to ensure that the VTable type and any
/// struct containing it is not safe to send across threads by default, as
/// XPCOM is generally not threadsafe.
///
/// If this type is marked as [rust_sync], there will be explicit `Send` and
/// `Sync` implementations on this type, which will override the inherited
/// negative impls from `Rc`.
__nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
// Make the rust compiler aware that there might be interior mutability
// in what actually implements the interface. This works around UB
// introduced by https://github.com/llvm/llvm-project/commit/01859da84bad95fd51d6a03b08b60c660e642a4f
// that a rust lint would make blatantly obvious, but doesn't exist.
// This prevents optimizations, but those optimizations weren't available
// before rustc switched to LLVM 16, and they now cause problems because
// of the UB.
// Until there's a lint available to find all our UB, it's simpler to
// avoid the UB in the first place, at the cost of preventing optimizations
// in places that don't cause UB. But again, those optimizations weren't
// available before.
__maybe_interior_mutability: ::std::cell::UnsafeCell<[u8; 0]>,
}
// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsIWebBrowserChrome.
unsafe impl XpCom for nsIWebBrowserChrome {
const IID: nsIID = nsID(0xe8c414c4, 0xdc38, 0x4ba3,
[0xab, 0x4e, 0xec, 0x4c, 0xbb, 0xe2, 0x29, 0x07]);
}
// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsIWebBrowserChrome {
#[inline]
unsafe fn addref(&self) {
self.AddRef();
}
#[inline]
unsafe fn release(&self) {
self.Release();
}
}
// This trait is implemented on all types which can be coerced to from nsIWebBrowserChrome.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsIWebBrowserChromeCoerce {
/// Cheaply cast a value of this type from a `nsIWebBrowserChrome`.
fn coerce_from(v: &nsIWebBrowserChrome) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWebBrowserChromeCoerce for nsIWebBrowserChrome {
#[inline]
fn coerce_from(v: &nsIWebBrowserChrome) -> &Self {
v
}
}
impl nsIWebBrowserChrome {
/// Cast this `nsIWebBrowserChrome` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWebBrowserChromeCoerce>(&self) -> &T {
T::coerce_from(self)
}
}
// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsIWebBrowserChrome {
type Target = nsISupports;
#[inline]
fn deref(&self) -> &nsISupports {
unsafe {
::std::mem::transmute(self)
}
}
}
// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsISupportsCoerce> nsIWebBrowserChromeCoerce for T {
#[inline]
fn coerce_from(v: &nsIWebBrowserChrome) -> &Self {
T::coerce_from(v)
}
}
// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsIWebBrowserChrome
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsIWebBrowserChromeVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void setLinkStatus (in AString status); */
pub SetLinkStatus: unsafe extern "system" fn (this: *const nsIWebBrowserChrome, status: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute unsigned long chromeFlags; */
pub GetChromeFlags: unsafe extern "system" fn (this: *const nsIWebBrowserChrome, aChromeFlags: *mut u32) -> ::nserror::nsresult,
/* attribute unsigned long chromeFlags; */
pub SetChromeFlags: unsafe extern "system" fn (this: *const nsIWebBrowserChrome, aChromeFlags: u32) -> ::nserror::nsresult,
/* void showAsModal (); */
pub ShowAsModal: unsafe extern "system" fn (this: *const nsIWebBrowserChrome) -> ::nserror::nsresult,
/* boolean isWindowModal (); */
pub IsWindowModal: unsafe extern "system" fn (this: *const nsIWebBrowserChrome, _retval: *mut bool) -> ::nserror::nsresult,
/* [noscript] void setDimensions (in DimensionRequest aRequest); */
/// Unable to generate binding because `Rust only supports [ref] / [ptr] native types`
pub SetDimensions: *const ::libc::c_void,
/* [noscript] void getDimensions (in DimensionKind aDimensionKind, out long aX, out long aY, out long aCX, out long aCY); */
/// Unable to generate binding because `Rust only supports [ref] / [ptr] native types`
pub GetDimensions: *const ::libc::c_void,
/* void blur (); */
pub Blur: unsafe extern "system" fn (this: *const nsIWebBrowserChrome) -> ::nserror::nsresult,
}
// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsIWebBrowserChrome {
/// ```text
/// /**
/// * Definitions for the chrome flags
/// */
/// ```
///
pub const CHROME_DEFAULT: u32 = 1;
pub const CHROME_WINDOW_BORDERS: u32 = 2;
pub const CHROME_WINDOW_CLOSE: u32 = 4;
pub const CHROME_WINDOW_RESIZE: u32 = 8;
pub const CHROME_MENUBAR: u32 = 16;
pub const CHROME_TOOLBAR: u32 = 32;
pub const CHROME_LOCATIONBAR: u32 = 64;
pub const CHROME_STATUSBAR: u32 = 128;
pub const CHROME_PERSONAL_TOOLBAR: u32 = 256;
pub const CHROME_SCROLLBARS: u32 = 512;
pub const CHROME_TITLEBAR: u32 = 1024;
pub const CHROME_EXTRA: u32 = 2048;
pub const CHROME_ALL: u32 = 4094;
pub const CHROME_WINDOW_MINIMIZE: u32 = 16384;
pub const CHROME_ALERT: u32 = 32768;
pub const CHROME_PRIVATE_WINDOW: u32 = 65536;
pub const CHROME_NON_PRIVATE_WINDOW: u32 = 131072;
pub const CHROME_PRIVATE_LIFETIME: u32 = 262144;
pub const CHROME_ALWAYS_ON_TOP: u32 = 524288;
pub const CHROME_REMOTE_WINDOW: u32 = 1048576;
pub const CHROME_FISSION_WINDOW: u32 = 2097152;
pub const CHROME_SUPPRESS_ANIMATION: u32 = 16777216;
pub const CHROME_WINDOW_RAISED: u32 = 33554432;
pub const CHROME_WINDOW_LOWERED: u32 = 67108864;
pub const CHROME_CENTER_SCREEN: u32 = 134217728;
pub const CHROME_DEPENDENT: u32 = 268435456;
pub const CHROME_MODAL: u32 = 536870912;
pub const CHROME_OPENAS_DIALOG: u32 = 1073741824;
pub const CHROME_OPENAS_CHROME: u32 = 2147483648;
pub const CHROME_MINIMAL_POPUP: u32 = 18126;
/// ```text
/// /**
/// * Called when the link hover status is being changed.
/// * @param status status string. empty string is an acceptable value
/// * meaning no link is hovered.
/// */
/// ```
///
/// `void setLinkStatus (in AString status);`
#[inline]
pub unsafe fn SetLinkStatus(&self, status: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).SetLinkStatus)(self, status)
}
/// ```text
/// /**
/// * The chrome flags for this browser chrome. The implementation should
/// * reflect the value of this attribute by hiding or showing its chrome
/// * appropriately.
/// */
/// ```
///
/// `attribute unsigned long chromeFlags;`
#[inline]
pub unsafe fn GetChromeFlags(&self, aChromeFlags: *mut u32) -> ::nserror::nsresult {
((*self.vtable).GetChromeFlags)(self, aChromeFlags)
}
/// ```text
/// /**
/// * The chrome flags for this browser chrome. The implementation should
/// * reflect the value of this attribute by hiding or showing its chrome
/// * appropriately.
/// */
/// ```
///
/// `attribute unsigned long chromeFlags;`
#[inline]
pub unsafe fn SetChromeFlags(&self, aChromeFlags: u32) -> ::nserror::nsresult {
((*self.vtable).SetChromeFlags)(self, aChromeFlags)
}
/// ```text
/// /**
/// * Shows the window as a modal window.
/// */
/// ```
///
/// `void showAsModal ();`
#[inline]
pub unsafe fn ShowAsModal(&self, ) -> ::nserror::nsresult {
((*self.vtable).ShowAsModal)(self, )
}
/// ```text
/// /**
/// * Is the window modal (that is, currently executing a modal loop)?
/// * @return true if it's a modal window
/// */
/// ```
///
/// `boolean isWindowModal ();`
#[inline]
pub unsafe fn IsWindowModal(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).IsWindowModal)(self, _retval)
}
/// ```text
/// /**
/// * Allows to request the change of individual dimensions of a window
/// * without specifying all dimensions.
/// *
/// * Gets called as fallback when no nsIBaseWindow is available.
/// *
/// * @see nsIBaseWindow
/// */
/// ```
///
/// `[noscript] void setDimensions (in DimensionRequest aRequest);`
const _SetDimensions: () = ();
/// ```text
/// /**
/// * Gets the dimensions of the window. The caller may pass
/// * <CODE>nullptr</CODE> for any value it is uninterested in receiving.
/// *
/// * Gets called as fallback when no nsIBaseWindow is available.
/// *
/// * @see nsIBaseWindow
/// */
/// ```
///
/// `[noscript] void getDimensions (in DimensionKind aDimensionKind, out long aX, out long aY, out long aCX, out long aCY);`
const _GetDimensions: () = ();
/// ```text
/// /**
/// * Blur the window. This should unfocus the window and send an onblur event.
/// */
/// ```
///
/// `void blur ();`
#[inline]
pub unsafe fn Blur(&self, ) -> ::nserror::nsresult {
((*self.vtable).Blur)(self, )
}
}