mozilla-central/__GENERATED__/dist/xpcrs/rt/nsIWindowsAlertsService.rs

Copy as Markdown

Other Tools

//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/alerts/nsIWindowsAlertsService.idl
//
/// `interface nsIWindowsAlertNotification : nsIAlertNotification`
///
// 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 nsIWindowsAlertNotification {
vtable: &'static nsIWindowsAlertNotificationVTable,
/// 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
// 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 nsIWindowsAlertNotification.
unsafe impl XpCom for nsIWindowsAlertNotification {
const IID: nsIID = nsID(0xa46c385b, 0xa45c, 0x4b48,
[0xab, 0x7c, 0xaa, 0xed, 0x12, 0x52, 0xbb, 0x83]);
}
// 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 nsIWindowsAlertNotification {
#[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 nsIWindowsAlertNotification.
// 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 nsIWindowsAlertNotificationCoerce {
/// Cheaply cast a value of this type from a `nsIWindowsAlertNotification`.
fn coerce_from(v: &nsIWindowsAlertNotification) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWindowsAlertNotificationCoerce for nsIWindowsAlertNotification {
#[inline]
fn coerce_from(v: &nsIWindowsAlertNotification) -> &Self {
v
}
}
impl nsIWindowsAlertNotification {
/// Cast this `nsIWindowsAlertNotification` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWindowsAlertNotificationCoerce>(&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 nsIWindowsAlertNotification {
type Target = nsIAlertNotification;
#[inline]
fn deref(&self) -> &nsIAlertNotification {
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: nsIAlertNotificationCoerce> nsIWindowsAlertNotificationCoerce for T {
#[inline]
fn coerce_from(v: &nsIWindowsAlertNotification) -> &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 nsIWindowsAlertNotification
// 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 nsIWindowsAlertNotificationVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsIAlertNotificationVTable,
/* attribute boolean handleActions; */
pub GetHandleActions: unsafe extern "system" fn (this: *const nsIWindowsAlertNotification, aHandleActions: *mut bool) -> ::nserror::nsresult,
/* attribute boolean handleActions; */
pub SetHandleActions: unsafe extern "system" fn (this: *const nsIWindowsAlertNotification, aHandleActions: bool) -> ::nserror::nsresult,
/* attribute nsIWindowsAlertNotification_ImagePlacement imagePlacement; */
pub GetImagePlacement: unsafe extern "system" fn (this: *const nsIWindowsAlertNotification, aImagePlacement: *mut u8) -> ::nserror::nsresult,
/* attribute nsIWindowsAlertNotification_ImagePlacement imagePlacement; */
pub SetImagePlacement: unsafe extern "system" fn (this: *const nsIWindowsAlertNotification, aImagePlacement: u8) -> ::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 nsIWindowsAlertNotification {
pub const eInline: u8 = 0;
pub const eHero: u8 = 1;
pub const eIcon: u8 = 2;
/// ```text
/// /**
/// * Boolean to signal that notification button actions will be handled, and the
/// * resulting action should be communicated back on clicks through the
/// * `aData` field.
/// */
/// ```
///
/// `attribute boolean handleActions;`
#[inline]
pub unsafe fn GetHandleActions(&self, aHandleActions: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetHandleActions)(self, aHandleActions)
}
/// ```text
/// /**
/// * Boolean to signal that notification button actions will be handled, and the
/// * resulting action should be communicated back on clicks through the
/// * `aData` field.
/// */
/// ```
///
/// `attribute boolean handleActions;`
#[inline]
pub unsafe fn SetHandleActions(&self, aHandleActions: bool) -> ::nserror::nsresult {
((*self.vtable).SetHandleActions)(self, aHandleActions)
}
/// ```text
/// /**
/// * Enum to specify image placement we want in the notification. n.b. in the
/// * future we could extend this to instead allow multiple images in differing
/// * placements in the same notification.
/// */
/// ```
///
/// `attribute nsIWindowsAlertNotification_ImagePlacement imagePlacement;`
#[inline]
pub unsafe fn GetImagePlacement(&self, aImagePlacement: *mut u8) -> ::nserror::nsresult {
((*self.vtable).GetImagePlacement)(self, aImagePlacement)
}
/// ```text
/// /**
/// * Enum to specify image placement we want in the notification. n.b. in the
/// * future we could extend this to instead allow multiple images in differing
/// * placements in the same notification.
/// */
/// ```
///
/// `attribute nsIWindowsAlertNotification_ImagePlacement imagePlacement;`
#[inline]
pub unsafe fn SetImagePlacement(&self, aImagePlacement: u8) -> ::nserror::nsresult {
((*self.vtable).SetImagePlacement)(self, aImagePlacement)
}
}
/// `interface nsIWindowsAlertsService : nsIAlertsService`
///
// 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 nsIWindowsAlertsService {
vtable: &'static nsIWindowsAlertsServiceVTable,
/// 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
// 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 nsIWindowsAlertsService.
unsafe impl XpCom for nsIWindowsAlertsService {
const IID: nsIID = nsID(0xe01c8066, 0xfb4b, 0x4304,
[0xb9, 0xc9, 0xab, 0x6e, 0xd4, 0xa8, 0x32, 0x2c]);
}
// 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 nsIWindowsAlertsService {
#[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 nsIWindowsAlertsService.
// 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 nsIWindowsAlertsServiceCoerce {
/// Cheaply cast a value of this type from a `nsIWindowsAlertsService`.
fn coerce_from(v: &nsIWindowsAlertsService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWindowsAlertsServiceCoerce for nsIWindowsAlertsService {
#[inline]
fn coerce_from(v: &nsIWindowsAlertsService) -> &Self {
v
}
}
impl nsIWindowsAlertsService {
/// Cast this `nsIWindowsAlertsService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWindowsAlertsServiceCoerce>(&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 nsIWindowsAlertsService {
type Target = nsIAlertsService;
#[inline]
fn deref(&self) -> &nsIAlertsService {
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: nsIAlertsServiceCoerce> nsIWindowsAlertsServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsIWindowsAlertsService) -> &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 nsIWindowsAlertsService
// 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 nsIWindowsAlertsServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsIAlertsServiceVTable,
/* [implicit_jscontext] Promise handleWindowsTag (in AString aWindowsTag); */
/// Unable to generate binding because `jscontext is unsupported`
pub HandleWindowsTag: *const ::libc::c_void,
/* AString getXmlStringForWindowsAlert (in nsIAlertNotification aAlert, [optional] in AString aWindowsTag); */
pub GetXmlStringForWindowsAlert: unsafe extern "system" fn (this: *const nsIWindowsAlertsService, aAlert: *const nsIAlertNotification, aWindowsTag: *const ::nsstring::nsAString, _retval: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* void removeAllNotificationsForInstall (); */
pub RemoveAllNotificationsForInstall: unsafe extern "system" fn (this: *const nsIWindowsAlertsService) -> ::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 nsIWindowsAlertsService {
/// ```text
/// /**
/// * If callbacks for the given Windows-specific tag string will be handled by
/// * this Firefox process, set the associated event.
/// *
/// * @param {AString} aWindowsTag the tag
/// * @return {Promise}
/// * @resolves {Object}
/// * Resolves with an Object, may contain the following optional
/// * properties if notification exists but wasn't registered with
/// * the WindowsAlertsService:
/// *
/// * `notificationData` {string} relaunch data, generally opaque to
/// * the Windows notification server DLL, for this relaunch.
/// *
/// * @rejects `nsresult` when there was an error retrieving the notification.
/// */
/// ```
///
/// `[implicit_jscontext] Promise handleWindowsTag (in AString aWindowsTag);`
const _HandleWindowsTag: () = ();
/// ```text
/// /**
/// * Get the Windows-specific XML generated for the given alert.
/// *
/// * @note This method is intended for testing purposes.
/// *
/// * @param {nsIAlertNotification} aAlert the alert
/// * @param {AString} an optional Windows tag; default is generated
/// * @return {string} generated XML
/// */
/// ```
///
/// `AString getXmlStringForWindowsAlert (in nsIAlertNotification aAlert, [optional] in AString aWindowsTag);`
#[inline]
pub unsafe fn GetXmlStringForWindowsAlert(&self, aAlert: *const nsIAlertNotification, aWindowsTag: *const ::nsstring::nsAString, _retval: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetXmlStringForWindowsAlert)(self, aAlert, aWindowsTag, _retval)
}
/// ```text
/// /**
/// * Removes all action center and snoozed notifications associated with this
/// * install. Note that this removes all notifications regardless of which profile
/// * they originated from.
/// */
/// ```
///
/// `void removeAllNotificationsForInstall ();`
#[inline]
pub unsafe fn RemoveAllNotificationsForInstall(&self, ) -> ::nserror::nsresult {
((*self.vtable).RemoveAllNotificationsForInstall)(self, )
}
}