Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsIMacDockSupport.idl
//
/// `interface nsIMacDockSupport : nsISupports`
///
/// ```text
/// /**
/// * Allow applications to interface with the Mac OS X Dock.
/// *
/// * Applications may indicate progress on their Dock icon. Only one such
/// * progress indicator is available to the entire application.
/// */
/// ```
///
// 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 nsIMacDockSupport {
vtable: &'static nsIMacDockSupportVTable,
/// 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 nsIMacDockSupport.
unsafe impl XpCom for nsIMacDockSupport {
const IID: nsIID = nsID(0x8be66b0c, 0x5f71, 0x4b74,
[0x98, 0xcf, 0x6c, 0x25, 0x51, 0xb9, 0x99, 0xb1]);
}
// 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 nsIMacDockSupport {
#[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 nsIMacDockSupport.
// 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 nsIMacDockSupportCoerce {
/// Cheaply cast a value of this type from a `nsIMacDockSupport`.
fn coerce_from(v: &nsIMacDockSupport) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIMacDockSupportCoerce for nsIMacDockSupport {
#[inline]
fn coerce_from(v: &nsIMacDockSupport) -> &Self {
v
}
}
impl nsIMacDockSupport {
/// Cast this `nsIMacDockSupport` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIMacDockSupportCoerce>(&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 nsIMacDockSupport {
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> nsIMacDockSupportCoerce for T {
#[inline]
fn coerce_from(v: &nsIMacDockSupport) -> &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 nsIMacDockSupport
// 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 nsIMacDockSupportVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* attribute nsIStandaloneNativeMenu dockMenu; */
pub GetDockMenu: unsafe extern "system" fn (this: *const nsIMacDockSupport, aDockMenu: *mut*const nsIStandaloneNativeMenu) -> ::nserror::nsresult,
/* attribute nsIStandaloneNativeMenu dockMenu; */
pub SetDockMenu: unsafe extern "system" fn (this: *const nsIMacDockSupport, aDockMenu: *const nsIStandaloneNativeMenu) -> ::nserror::nsresult,
/* void activateApplication (in boolean aIgnoreOtherApplications); */
pub ActivateApplication: unsafe extern "system" fn (this: *const nsIMacDockSupport, aIgnoreOtherApplications: bool) -> ::nserror::nsresult,
/* attribute AString badgeText; */
pub GetBadgeText: unsafe extern "system" fn (this: *const nsIMacDockSupport, aBadgeText: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute AString badgeText; */
pub SetBadgeText: unsafe extern "system" fn (this: *const nsIMacDockSupport, aBadgeText: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void setBadgeImage (in imgIContainer aBadgeImage, [optional] in nsISVGPaintContext aPaintContext); */
pub SetBadgeImage: unsafe extern "system" fn (this: *const nsIMacDockSupport, aBadgeImage: *const imgIContainer, aPaintContext: *const nsISVGPaintContext) -> ::nserror::nsresult,
/* readonly attribute boolean isAppInDock; */
pub GetIsAppInDock: unsafe extern "system" fn (this: *const nsIMacDockSupport, aIsAppInDock: *mut bool) -> ::nserror::nsresult,
/* boolean ensureAppIsPinnedToDock ([optional] in AString aAppPath, [optional] in AString aAppToReplacePath); */
pub EnsureAppIsPinnedToDock: unsafe extern "system" fn (this: *const nsIMacDockSupport, aAppPath: *const ::nsstring::nsAString, aAppToReplacePath: *const ::nsstring::nsAString, _retval: *mut bool) -> ::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 nsIMacDockSupport {
/// ```text
/// /**
/// * Menu to use for application-specific dock menu items.
/// */
/// ```
///
/// `attribute nsIStandaloneNativeMenu dockMenu;`
#[inline]
pub unsafe fn GetDockMenu(&self, aDockMenu: *mut*const nsIStandaloneNativeMenu) -> ::nserror::nsresult {
((*self.vtable).GetDockMenu)(self, aDockMenu)
}
/// ```text
/// /**
/// * Menu to use for application-specific dock menu items.
/// */
/// ```
///
/// `attribute nsIStandaloneNativeMenu dockMenu;`
#[inline]
pub unsafe fn SetDockMenu(&self, aDockMenu: *const nsIStandaloneNativeMenu) -> ::nserror::nsresult {
((*self.vtable).SetDockMenu)(self, aDockMenu)
}
/// ```text
/// /**
/// * Activate the application. This should be used by an application to
/// * activate itself when a dock menu is selected as selection of a dock menu
/// * item does not automatically activate the application.
/// *
/// * @param aIgnoreOtherApplications If false, the application is activated
/// * only if no other application is currently active. If true, the
/// * application activates regardless.
/// */
/// ```
///
/// `void activateApplication (in boolean aIgnoreOtherApplications);`
#[inline]
pub unsafe fn ActivateApplication(&self, aIgnoreOtherApplications: bool) -> ::nserror::nsresult {
((*self.vtable).ActivateApplication)(self, aIgnoreOtherApplications)
}
/// ```text
/// /**
/// * Text used to badge the dock tile. Setting this will remove any badge image.
/// */
/// ```
///
/// `attribute AString badgeText;`
#[inline]
pub unsafe fn GetBadgeText(&self, aBadgeText: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetBadgeText)(self, aBadgeText)
}
/// ```text
/// /**
/// * Text used to badge the dock tile. Setting this will remove any badge image.
/// */
/// ```
///
/// `attribute AString badgeText;`
#[inline]
pub unsafe fn SetBadgeText(&self, aBadgeText: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).SetBadgeText)(self, aBadgeText)
}
/// ```text
/// /**
/// * An image to add to the dock icon as a badge. Setting this will remove any
/// * badgeText. If an SVG image is passed the given paint context is used to
/// * set the stroke and fill properties.
/// */
/// ```
///
/// `void setBadgeImage (in imgIContainer aBadgeImage, [optional] in nsISVGPaintContext aPaintContext);`
#[inline]
pub unsafe fn SetBadgeImage(&self, aBadgeImage: *const imgIContainer, aPaintContext: *const nsISVGPaintContext) -> ::nserror::nsresult {
((*self.vtable).SetBadgeImage)(self, aBadgeImage, aPaintContext)
}
/// ```text
/// /**
/// * True if this app is in the list of apps that are persisted to the macOS
/// * Dock (as if the user selected "Keep in Dock").
/// */
/// ```
///
/// `readonly attribute boolean isAppInDock;`
#[inline]
pub unsafe fn GetIsAppInDock(&self, aIsAppInDock: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetIsAppInDock)(self, aIsAppInDock)
}
/// ```text
/// /**
/// * Ensure that there is a tile for this app in the list of apps that are
/// * persisted to the macOS Dock (equivalent to the user selected "Keep in
/// * Dock").
/// *
/// * The position for the [new] app tile is:
/// *
/// * - its current position if it already exists, else
/// * - the position of `aAppToReplacePath` if it exists, else
/// * - directly after the last app with the same .app name, else
/// * - directly after the last known browser app (see `browserAppNames` in
/// * nsMacDockSupport.mm), else
/// * - at the end of the persisted app list.
/// *
/// * @param aAppPath [optional] The path of the .app to persist to the Dock
/// * (defaults to the path of the current app).
/// * @param aAppToReplacePath [optional] The path of a .app that should be
/// * replaced if it is in the list of persisted apps. This is useful when we
/// * prompt the user to install the app when the app is being run directly
/// * from a .dmg and the user may have dragged that .app file to the dock.
/// * @return true if the app was already in the list of persisted apps or if it
/// * was successfully added, else returns false.
/// */
/// ```
///
/// `boolean ensureAppIsPinnedToDock ([optional] in AString aAppPath, [optional] in AString aAppToReplacePath);`
#[inline]
pub unsafe fn EnsureAppIsPinnedToDock(&self, aAppPath: *const ::nsstring::nsAString, aAppToReplacePath: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).EnsureAppIsPinnedToDock)(self, aAppPath, aAppToReplacePath, _retval)
}
}