Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsITaskbarPreview.idl
//
/// `interface nsITaskbarPreview : nsISupports`
///
/// ```text
/// /**
/// * nsITaskbarPreview
/// *
/// * Common interface for both window and tab taskbar previews. This interface
/// * cannot be instantiated directly.
/// *
/// */
/// ```
///
// 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 nsITaskbarPreview {
vtable: &'static nsITaskbarPreviewVTable,
/// 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 nsITaskbarPreview.
unsafe impl XpCom for nsITaskbarPreview {
const IID: nsIID = nsID(0xcbfdf766, 0xd002, 0x403b,
[0xa3, 0xd9, 0xb0, 0x91, 0xc9, 0xad, 0x46, 0x5b]);
}
// 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 nsITaskbarPreview {
#[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 nsITaskbarPreview.
// 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 nsITaskbarPreviewCoerce {
/// Cheaply cast a value of this type from a `nsITaskbarPreview`.
fn coerce_from(v: &nsITaskbarPreview) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsITaskbarPreviewCoerce for nsITaskbarPreview {
#[inline]
fn coerce_from(v: &nsITaskbarPreview) -> &Self {
v
}
}
impl nsITaskbarPreview {
/// Cast this `nsITaskbarPreview` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsITaskbarPreviewCoerce>(&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 nsITaskbarPreview {
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> nsITaskbarPreviewCoerce for T {
#[inline]
fn coerce_from(v: &nsITaskbarPreview) -> &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 nsITaskbarPreview
// 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 nsITaskbarPreviewVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* attribute nsITaskbarPreviewController controller; */
pub GetController: unsafe extern "system" fn (this: *const nsITaskbarPreview, aController: *mut*const nsITaskbarPreviewController) -> ::nserror::nsresult,
/* attribute nsITaskbarPreviewController controller; */
pub SetController: unsafe extern "system" fn (this: *const nsITaskbarPreview, aController: *const nsITaskbarPreviewController) -> ::nserror::nsresult,
/* attribute AString tooltip; */
pub GetTooltip: unsafe extern "system" fn (this: *const nsITaskbarPreview, aTooltip: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute AString tooltip; */
pub SetTooltip: unsafe extern "system" fn (this: *const nsITaskbarPreview, aTooltip: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute boolean visible; */
pub GetVisible: unsafe extern "system" fn (this: *const nsITaskbarPreview, aVisible: *mut bool) -> ::nserror::nsresult,
/* attribute boolean visible; */
pub SetVisible: unsafe extern "system" fn (this: *const nsITaskbarPreview, aVisible: bool) -> ::nserror::nsresult,
/* attribute boolean active; */
pub GetActive: unsafe extern "system" fn (this: *const nsITaskbarPreview, aActive: *mut bool) -> ::nserror::nsresult,
/* attribute boolean active; */
pub SetActive: unsafe extern "system" fn (this: *const nsITaskbarPreview, aActive: bool) -> ::nserror::nsresult,
/* void invalidate (); */
pub Invalidate: unsafe extern "system" fn (this: *const nsITaskbarPreview) -> ::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 nsITaskbarPreview {
/// ```text
/// /**
/// * The controller for this preview. A controller is required to provide
/// * the behavior and appearance of the taskbar previews. It is responsible for
/// * determining the size and contents of the preview, which buttons are
/// * displayed and how the application responds to user actions on the preview.
/// *
/// * Neither preview makes full use of the controller. See the documentation
/// * for nsITaskbarWindowPreview and nsITaskbarTabPreview for details on which
/// * controller methods are used.
/// *
/// * The controller is not allowed to be null.
/// *
/// * @see nsITaskbarPreviewController
/// */
/// ```
///
/// `attribute nsITaskbarPreviewController controller;`
#[inline]
pub unsafe fn GetController(&self, aController: *mut*const nsITaskbarPreviewController) -> ::nserror::nsresult {
((*self.vtable).GetController)(self, aController)
}
/// ```text
/// /**
/// * The controller for this preview. A controller is required to provide
/// * the behavior and appearance of the taskbar previews. It is responsible for
/// * determining the size and contents of the preview, which buttons are
/// * displayed and how the application responds to user actions on the preview.
/// *
/// * Neither preview makes full use of the controller. See the documentation
/// * for nsITaskbarWindowPreview and nsITaskbarTabPreview for details on which
/// * controller methods are used.
/// *
/// * The controller is not allowed to be null.
/// *
/// * @see nsITaskbarPreviewController
/// */
/// ```
///
/// `attribute nsITaskbarPreviewController controller;`
#[inline]
pub unsafe fn SetController(&self, aController: *const nsITaskbarPreviewController) -> ::nserror::nsresult {
((*self.vtable).SetController)(self, aController)
}
/// ```text
/// /**
/// * The tooltip displayed above the preview when the user hovers over it
/// *
/// * Default: an empty string
/// */
/// ```
///
/// `attribute AString tooltip;`
#[inline]
pub unsafe fn GetTooltip(&self, aTooltip: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetTooltip)(self, aTooltip)
}
/// ```text
/// /**
/// * The tooltip displayed above the preview when the user hovers over it
/// *
/// * Default: an empty string
/// */
/// ```
///
/// `attribute AString tooltip;`
#[inline]
pub unsafe fn SetTooltip(&self, aTooltip: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).SetTooltip)(self, aTooltip)
}
/// ```text
/// /**
/// * Whether or not the preview is visible.
/// *
/// * Changing this option is expensive for tab previews since toggling this
/// * option will destroy/create the proxy window and its registration with the
/// * taskbar. If any step of that fails, an exception will be thrown.
/// *
/// * For window previews, this operation is very cheap.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean visible;`
#[inline]
pub unsafe fn GetVisible(&self, aVisible: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetVisible)(self, aVisible)
}
/// ```text
/// /**
/// * Whether or not the preview is visible.
/// *
/// * Changing this option is expensive for tab previews since toggling this
/// * option will destroy/create the proxy window and its registration with the
/// * taskbar. If any step of that fails, an exception will be thrown.
/// *
/// * For window previews, this operation is very cheap.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean visible;`
#[inline]
pub unsafe fn SetVisible(&self, aVisible: bool) -> ::nserror::nsresult {
((*self.vtable).SetVisible)(self, aVisible)
}
/// ```text
/// /**
/// * Gets/sets whether or not the preview is marked active (selected) in the
/// * taskbar.
/// */
/// ```
///
/// `attribute boolean active;`
#[inline]
pub unsafe fn GetActive(&self, aActive: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetActive)(self, aActive)
}
/// ```text
/// /**
/// * Gets/sets whether or not the preview is marked active (selected) in the
/// * taskbar.
/// */
/// ```
///
/// `attribute boolean active;`
#[inline]
pub unsafe fn SetActive(&self, aActive: bool) -> ::nserror::nsresult {
((*self.vtable).SetActive)(self, aActive)
}
/// ```text
/// /**
/// * Invalidates the taskbar's cached image of this preview, forcing a redraw
/// * if necessary
/// */
/// ```
///
/// `void invalidate ();`
#[inline]
pub unsafe fn Invalidate(&self, ) -> ::nserror::nsresult {
((*self.vtable).Invalidate)(self, )
}
}