//
// DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/nsIClipboardCommands.idl
//


/// `interface nsIClipboardCommands : nsISupports`
///

/// ```text
/// /**
///  * An interface for embedding clients who wish to interact with
///  * the system-wide OS clipboard. Mozilla does not use a private
///  * clipboard, instead it places its data directly onto the system
///  * clipboard. The webshell implements this interface.
///  */
/// ```
///

// 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 nsIClipboardCommands {
    vtable: *const nsIClipboardCommandsVTable,

    /// This field is a phantomdata to ensure that the VTable type and any
    /// struct containing it is not safe to send across threads, as XPCOM is
    /// generally not threadsafe.
    ///
    /// XPCOM interfaces in general are not safe to send across threads.
    __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
}

// 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 nsIClipboardCommands.
unsafe impl XpCom for nsIClipboardCommands {
    const IID: nsIID = nsID(0xb8100c90, 0x73be, 0x11d2,
        [0x92, 0xa5, 0x00, 0x10, 0x5a, 0x1b, 0x0d, 0x64]);
}

// 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 nsIClipboardCommands {
    #[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 nsIClipboardCommands.
// 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 nsIClipboardCommandsCoerce {
    /// Cheaply cast a value of this type from a `nsIClipboardCommands`.
    fn coerce_from(v: &nsIClipboardCommands) -> &Self;
}

// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIClipboardCommandsCoerce for nsIClipboardCommands {
    #[inline]
    fn coerce_from(v: &nsIClipboardCommands) -> &Self {
        v
    }
}

impl nsIClipboardCommands {
    /// Cast this `nsIClipboardCommands` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIClipboardCommandsCoerce>(&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 nsIClipboardCommands {
    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> nsIClipboardCommandsCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIClipboardCommands) -> &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 nsIClipboardCommands
// 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 nsIClipboardCommandsVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* boolean canCutSelection (); */
    pub CanCutSelection: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* boolean canCopySelection (); */
    pub CanCopySelection: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* boolean canCopyLinkLocation (); */
    pub CanCopyLinkLocation: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* boolean canCopyImageLocation (); */
    pub CanCopyImageLocation: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* boolean canCopyImageContents (); */
    pub CanCopyImageContents: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* boolean canPaste (); */
    pub CanPaste: unsafe extern "system" fn (this: *const nsIClipboardCommands, _retval: *mut bool) -> nsresult,

    /* void cutSelection (); */
    pub CutSelection: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void copySelection (); */
    pub CopySelection: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void copyLinkLocation (); */
    pub CopyLinkLocation: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void copyImageLocation (); */
    pub CopyImageLocation: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void copyImageContents (); */
    pub CopyImageContents: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void paste (); */
    pub Paste: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void selectAll (); */
    pub SelectAll: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> nsresult,

    /* void selectNone (); */
    pub SelectNone: unsafe extern "system" fn (this: *const nsIClipboardCommands) -> 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 nsIClipboardCommands {

    /// ```text
    /// /**
    ///    * Returns whether there is a selection and it is not read-only.
    ///    *
    ///    * @return <code>true</code> if the current selection can be cut,
    ///    *          <code>false</code> otherwise.
    ///    */
    /// ```
    ///

    /// `boolean canCutSelection ();`
    #[inline]
    pub unsafe fn CanCutSelection(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanCutSelection)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether there is a selection and it is copyable.
    ///    *
    ///    * @return <code>true</code> if there is a selection,
    ///    *          <code>false</code> otherwise.
    ///    */
    /// ```
    ///

    /// `boolean canCopySelection ();`
    #[inline]
    pub unsafe fn CanCopySelection(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanCopySelection)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether we can copy a link location.
    ///    *
    ///    * @return <code>true</code> if a link is selected,
    ///    *           <code>false</code> otherwise.
    ///    */
    /// ```
    ///

    /// `boolean canCopyLinkLocation ();`
    #[inline]
    pub unsafe fn CanCopyLinkLocation(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanCopyLinkLocation)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether we can copy an image location.
    ///    *
    ///    * @return <code>true</code> if an image is selected,
    ///               <code>false</code> otherwise.
    ///    */
    /// ```
    ///

    /// `boolean canCopyImageLocation ();`
    #[inline]
    pub unsafe fn CanCopyImageLocation(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanCopyImageLocation)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether we can copy an image's contents.
    ///    *
    ///    * @return <code>true</code> if an image is selected,
    ///    *          <code>false</code> otherwise
    ///    */
    /// ```
    ///

    /// `boolean canCopyImageContents ();`
    #[inline]
    pub unsafe fn CanCopyImageContents(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanCopyImageContents)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether the current contents of the clipboard can be
    ///    * pasted and if the current selection is not read-only.
    ///    *
    ///    * @return <code>true</code> there is data to paste on the clipboard
    ///    *          and the current selection is not read-only,
    ///    *          <code>false</code> otherwise
    ///    */
    /// ```
    ///

    /// `boolean canPaste ();`
    #[inline]
    pub unsafe fn CanPaste(&self, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CanPaste)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Cut the current selection onto the clipboard.
    ///    */
    /// ```
    ///

    /// `void cutSelection ();`
    #[inline]
    pub unsafe fn CutSelection(&self, ) -> nsresult {
        ((*self.vtable).CutSelection)(self, )
    }


    /// ```text
    /// /**
    ///    * Copy the current selection onto the clipboard.
    ///    */
    /// ```
    ///

    /// `void copySelection ();`
    #[inline]
    pub unsafe fn CopySelection(&self, ) -> nsresult {
        ((*self.vtable).CopySelection)(self, )
    }


    /// ```text
    /// /**
    ///    * Copy the link location of the current selection (e.g.,
        ///    * the |href| attribute of a selected |a| tag).
    ///    */
    /// ```
    ///

    /// `void copyLinkLocation ();`
    #[inline]
    pub unsafe fn CopyLinkLocation(&self, ) -> nsresult {
        ((*self.vtable).CopyLinkLocation)(self, )
    }


    /// ```text
    /// /**
    ///    * Copy the location of the selected image.
    ///    */
    /// ```
    ///

    /// `void copyImageLocation ();`
    #[inline]
    pub unsafe fn CopyImageLocation(&self, ) -> nsresult {
        ((*self.vtable).CopyImageLocation)(self, )
    }


    /// ```text
    /// /**
    ///    * Copy the contents of the selected image.
    ///    */
    /// ```
    ///

    /// `void copyImageContents ();`
    #[inline]
    pub unsafe fn CopyImageContents(&self, ) -> nsresult {
        ((*self.vtable).CopyImageContents)(self, )
    }


    /// ```text
    /// /**
    ///    * Paste the contents of the clipboard into the current selection.
    ///    */
    /// ```
    ///

    /// `void paste ();`
    #[inline]
    pub unsafe fn Paste(&self, ) -> nsresult {
        ((*self.vtable).Paste)(self, )
    }


    /// ```text
    /// /**
    ///    * Select the entire contents.
    ///    */
    /// ```
    ///

    /// `void selectAll ();`
    #[inline]
    pub unsafe fn SelectAll(&self, ) -> nsresult {
        ((*self.vtable).SelectAll)(self, )
    }


    /// ```text
    /// /**
    ///    * Clear the current selection (if any). Insertion point ends up
    ///    * at beginning of current selection.
    ///    */
    /// ```
    ///

    /// `void selectNone ();`
    #[inline]
    pub unsafe fn SelectNone(&self, ) -> nsresult {
        ((*self.vtable).SelectNone)(self, )
    }


}