Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsITaskbarPreviewButton.idl
//
/// `interface nsITaskbarPreviewButton : nsISupports`
///
/// ```text
/// /**
/// * nsITaskbarPreviewButton
/// *
/// * Provides access to a window preview's toolbar button's properties.
/// */
/// ```
///
// 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 nsITaskbarPreviewButton {
vtable: &'static nsITaskbarPreviewButtonVTable,
/// 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 nsITaskbarPreviewButton.
unsafe impl XpCom for nsITaskbarPreviewButton {
const IID: nsIID = nsID(0xced8842d, 0xfe37, 0x4767,
[0x9a, 0x8e, 0xfd, 0xfa, 0x56, 0x51, 0x0c, 0x75]);
}
// 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 nsITaskbarPreviewButton {
#[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 nsITaskbarPreviewButton.
// 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 nsITaskbarPreviewButtonCoerce {
/// Cheaply cast a value of this type from a `nsITaskbarPreviewButton`.
fn coerce_from(v: &nsITaskbarPreviewButton) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsITaskbarPreviewButtonCoerce for nsITaskbarPreviewButton {
#[inline]
fn coerce_from(v: &nsITaskbarPreviewButton) -> &Self {
v
}
}
impl nsITaskbarPreviewButton {
/// Cast this `nsITaskbarPreviewButton` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsITaskbarPreviewButtonCoerce>(&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 nsITaskbarPreviewButton {
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> nsITaskbarPreviewButtonCoerce for T {
#[inline]
fn coerce_from(v: &nsITaskbarPreviewButton) -> &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 nsITaskbarPreviewButton
// 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 nsITaskbarPreviewButtonVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* attribute AString tooltip; */
pub GetTooltip: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aTooltip: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute AString tooltip; */
pub SetTooltip: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aTooltip: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* attribute boolean dismissOnClick; */
pub GetDismissOnClick: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aDismissOnClick: *mut bool) -> ::nserror::nsresult,
/* attribute boolean dismissOnClick; */
pub SetDismissOnClick: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aDismissOnClick: bool) -> ::nserror::nsresult,
/* attribute boolean hasBorder; */
pub GetHasBorder: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aHasBorder: *mut bool) -> ::nserror::nsresult,
/* attribute boolean hasBorder; */
pub SetHasBorder: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aHasBorder: bool) -> ::nserror::nsresult,
/* attribute boolean disabled; */
pub GetDisabled: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aDisabled: *mut bool) -> ::nserror::nsresult,
/* attribute boolean disabled; */
pub SetDisabled: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aDisabled: bool) -> ::nserror::nsresult,
/* attribute imgIContainer image; */
pub GetImage: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aImage: *mut*const imgIContainer) -> ::nserror::nsresult,
/* attribute imgIContainer image; */
pub SetImage: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aImage: *const imgIContainer) -> ::nserror::nsresult,
/* attribute boolean visible; */
pub GetVisible: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aVisible: *mut bool) -> ::nserror::nsresult,
/* attribute boolean visible; */
pub SetVisible: unsafe extern "system" fn (this: *const nsITaskbarPreviewButton, aVisible: 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 nsITaskbarPreviewButton {
/// ```text
/// /**
/// * The button's tooltip.
/// *
/// * 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 button's tooltip.
/// *
/// * 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
/// /**
/// * True if the array of previews should be dismissed when this button is clicked.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean dismissOnClick;`
#[inline]
pub unsafe fn GetDismissOnClick(&self, aDismissOnClick: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetDismissOnClick)(self, aDismissOnClick)
}
/// ```text
/// /**
/// * True if the array of previews should be dismissed when this button is clicked.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean dismissOnClick;`
#[inline]
pub unsafe fn SetDismissOnClick(&self, aDismissOnClick: bool) -> ::nserror::nsresult {
((*self.vtable).SetDismissOnClick)(self, aDismissOnClick)
}
/// ```text
/// /**
/// * True if the taskbar should draw a border around this button's image.
/// *
/// * Default: true
/// */
/// ```
///
/// `attribute boolean hasBorder;`
#[inline]
pub unsafe fn GetHasBorder(&self, aHasBorder: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetHasBorder)(self, aHasBorder)
}
/// ```text
/// /**
/// * True if the taskbar should draw a border around this button's image.
/// *
/// * Default: true
/// */
/// ```
///
/// `attribute boolean hasBorder;`
#[inline]
pub unsafe fn SetHasBorder(&self, aHasBorder: bool) -> ::nserror::nsresult {
((*self.vtable).SetHasBorder)(self, aHasBorder)
}
/// ```text
/// /**
/// * True if the button is disabled. This is not the same as visible.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean disabled;`
#[inline]
pub unsafe fn GetDisabled(&self, aDisabled: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetDisabled)(self, aDisabled)
}
/// ```text
/// /**
/// * True if the button is disabled. This is not the same as visible.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean disabled;`
#[inline]
pub unsafe fn SetDisabled(&self, aDisabled: bool) -> ::nserror::nsresult {
((*self.vtable).SetDisabled)(self, aDisabled)
}
/// ```text
/// /**
/// * The icon used for the button.
/// *
/// * Default: null
/// */
/// ```
///
/// `attribute imgIContainer image;`
#[inline]
pub unsafe fn GetImage(&self, aImage: *mut*const imgIContainer) -> ::nserror::nsresult {
((*self.vtable).GetImage)(self, aImage)
}
/// ```text
/// /**
/// * The icon used for the button.
/// *
/// * Default: null
/// */
/// ```
///
/// `attribute imgIContainer image;`
#[inline]
pub unsafe fn SetImage(&self, aImage: *const imgIContainer) -> ::nserror::nsresult {
((*self.vtable).SetImage)(self, aImage)
}
/// ```text
/// /**
/// * True if the button is shown. Buttons that are invisible do not
/// * participate in the layout of buttons underneath the preview.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean visible;`
#[inline]
pub unsafe fn GetVisible(&self, aVisible: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetVisible)(self, aVisible)
}
/// ```text
/// /**
/// * True if the button is shown. Buttons that are invisible do not
/// * participate in the layout of buttons underneath the preview.
/// *
/// * Default: false
/// */
/// ```
///
/// `attribute boolean visible;`
#[inline]
pub unsafe fn SetVisible(&self, aVisible: bool) -> ::nserror::nsresult {
((*self.vtable).SetVisible)(self, aVisible)
}
}