Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsIWindowsUIUtils.idl
//
/// `interface nsIWindowsUIUtils : nsISupports`
///
// 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 nsIWindowsUIUtils {
vtable: &'static nsIWindowsUIUtilsVTable,
/// 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 nsIWindowsUIUtils.
unsafe impl XpCom for nsIWindowsUIUtils {
const IID: nsIID = nsID(0xaa8a0ecf, 0x96a1, 0x418c,
[0xb8, 0x0e, 0xf2, 0x4a, 0xe1, 0x8b, 0xbe, 0xdc]);
}
// 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 nsIWindowsUIUtils {
#[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 nsIWindowsUIUtils.
// 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 nsIWindowsUIUtilsCoerce {
/// Cheaply cast a value of this type from a `nsIWindowsUIUtils`.
fn coerce_from(v: &nsIWindowsUIUtils) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWindowsUIUtilsCoerce for nsIWindowsUIUtils {
#[inline]
fn coerce_from(v: &nsIWindowsUIUtils) -> &Self {
v
}
}
impl nsIWindowsUIUtils {
/// Cast this `nsIWindowsUIUtils` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWindowsUIUtilsCoerce>(&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 nsIWindowsUIUtils {
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> nsIWindowsUIUtilsCoerce for T {
#[inline]
fn coerce_from(v: &nsIWindowsUIUtils) -> &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 nsIWindowsUIUtils
// 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 nsIWindowsUIUtilsVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* readonly attribute long systemSmallIconSize; */
pub GetSystemSmallIconSize: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aSystemSmallIconSize: *mut i32) -> ::nserror::nsresult,
/* readonly attribute long systemLargeIconSize; */
pub GetSystemLargeIconSize: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aSystemLargeIconSize: *mut i32) -> ::nserror::nsresult,
/* void setWindowIcon (in mozIDOMWindowProxy aWindow, in imgIContainer aSmallIcon, in imgIContainer aLargeIcon); */
pub SetWindowIcon: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aWindow: *const mozIDOMWindowProxy, aSmallIcon: *const imgIContainer, aLargeIcon: *const imgIContainer) -> ::nserror::nsresult,
/* void setWindowIconFromExe (in mozIDOMWindowProxy aWindow, in AString aExe, in unsigned short aIndex); */
pub SetWindowIconFromExe: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aWindow: *const mozIDOMWindowProxy, aExe: *const ::nsstring::nsAString, aIndex: u16) -> ::nserror::nsresult,
/* void setWindowIconNoData (in mozIDOMWindowProxy aWindow); */
pub SetWindowIconNoData: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aWindow: *const mozIDOMWindowProxy) -> ::nserror::nsresult,
/* readonly attribute boolean inWin10TabletMode; */
pub GetInWin10TabletMode: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aInWin10TabletMode: *mut bool) -> ::nserror::nsresult,
/* readonly attribute boolean inWin11TabletMode; */
pub GetInWin11TabletMode: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, aInWin11TabletMode: *mut bool) -> ::nserror::nsresult,
/* void shareUrl (in AString shareTitle, in AString urlToShare); */
pub ShareUrl: unsafe extern "system" fn (this: *const nsIWindowsUIUtils, shareTitle: *const ::nsstring::nsAString, urlToShare: *const ::nsstring::nsAString) -> ::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 nsIWindowsUIUtils {
/// `readonly attribute long systemSmallIconSize;`
#[inline]
pub unsafe fn GetSystemSmallIconSize(&self, aSystemSmallIconSize: *mut i32) -> ::nserror::nsresult {
((*self.vtable).GetSystemSmallIconSize)(self, aSystemSmallIconSize)
}
/// `readonly attribute long systemLargeIconSize;`
#[inline]
pub unsafe fn GetSystemLargeIconSize(&self, aSystemLargeIconSize: *mut i32) -> ::nserror::nsresult {
((*self.vtable).GetSystemLargeIconSize)(self, aSystemLargeIconSize)
}
/// `void setWindowIcon (in mozIDOMWindowProxy aWindow, in imgIContainer aSmallIcon, in imgIContainer aLargeIcon);`
#[inline]
pub unsafe fn SetWindowIcon(&self, aWindow: *const mozIDOMWindowProxy, aSmallIcon: *const imgIContainer, aLargeIcon: *const imgIContainer) -> ::nserror::nsresult {
((*self.vtable).SetWindowIcon)(self, aWindow, aSmallIcon, aLargeIcon)
}
/// `void setWindowIconFromExe (in mozIDOMWindowProxy aWindow, in AString aExe, in unsigned short aIndex);`
#[inline]
pub unsafe fn SetWindowIconFromExe(&self, aWindow: *const mozIDOMWindowProxy, aExe: *const ::nsstring::nsAString, aIndex: u16) -> ::nserror::nsresult {
((*self.vtable).SetWindowIconFromExe)(self, aWindow, aExe, aIndex)
}
/// `void setWindowIconNoData (in mozIDOMWindowProxy aWindow);`
#[inline]
pub unsafe fn SetWindowIconNoData(&self, aWindow: *const mozIDOMWindowProxy) -> ::nserror::nsresult {
((*self.vtable).SetWindowIconNoData)(self, aWindow)
}
/// ```text
/// /**
/// * Whether the OS is currently in Win10's Tablet Mode. Always false on
/// * versions of Windows other than Win10.
/// *
/// * (Win10 tablet mode is sufficiently different from Win11 tablet mode that
/// * there is no single getter to retrieve whether we're in a generic "tablet
/// * mode".)
/// */
/// ```
///
/// `readonly attribute boolean inWin10TabletMode;`
#[inline]
pub unsafe fn GetInWin10TabletMode(&self, aInWin10TabletMode: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetInWin10TabletMode)(self, aInWin10TabletMode)
}
/// ```text
/// /**
/// * Whether the OS is currently in Windows 11's tablet mode. Always false on
/// * versions of Windows prior to Win11.
/// *
/// * (Win11 tablet mode is sufficiently different from Win10 tablet mode that
/// * there is no single getter to retrieve whether we're in a generic "tablet
/// * mode".)
/// */
/// ```
///
/// `readonly attribute boolean inWin11TabletMode;`
#[inline]
pub unsafe fn GetInWin11TabletMode(&self, aInWin11TabletMode: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetInWin11TabletMode)(self, aInWin11TabletMode)
}
/// ```text
/// /**
/// * Share URL
/// */
/// ```
///
/// `void shareUrl (in AString shareTitle, in AString urlToShare);`
#[inline]
pub unsafe fn ShareUrl(&self, shareTitle: *const ::nsstring::nsAString, urlToShare: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).ShareUrl)(self, shareTitle, urlToShare)
}
}