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


/// `interface nsIClipboardDragDropHooks : nsISupports`
///

/// ```text
/// /**
///  * Interfaces for overriding the built-in drag, drop, copy, and paste
///  * implementations in the content area and editors. Use this to do things
///  * such as prevent a drag from starting, adding or removing
///  * data and flavors, or preventing the drop.
///  *
///  * Embedders who want to have these hooks made available should implement
///  * nsIClipboardDragDropHooks and use the command manager to send the
///  * appropriate commands with these parameters/settings:
///  *      command:  cmd_clipboardDragDropHook
///  *
///  *      params        value type   possible values
///  *      "addhook"     isupports    nsIClipboardDragDropHooks as nsISupports
///  *      "removehook"  isupports    nsIClipboardDragDropHooks as nsISupports
///  *
///  * Notes:
///  *  * Overrides/hooks need to be added to each window (as appropriate).
///  *    Adding them to the first window does not enable them for every window.
///  *  * If more than one implementation is set for a window, the hooks will be
///  *    called in the order they are added.
///  *  * Adding the same hook to the same window will not add a second call.
///  *    Each hook can only be called once per user action/api.
///  *  * Not all hooks are guaranteed to be called.  If there are multiple hooks
///  *    set for a window, any of them has an opportunity to cancel the action
///  *    so no further processing will occur.
///  *  * If any errors occur (without setting the boolean result) the default
///  *    action will occur.
///  *  * AllowDrop will be called MANY times during drag so ensure that it is
///  *    efficient.
///  */
/// ```
///

// 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 nsIClipboardDragDropHooks {
    vtable: *const nsIClipboardDragDropHooksVTable,

    /// 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 nsIClipboardDragDropHooks.
unsafe impl XpCom for nsIClipboardDragDropHooks {
    const IID: nsIID = nsID(0xe03e6c5e, 0x0d84, 0x4c0b,
        [0x87, 0x39, 0xe6, 0xb8, 0xd5, 0x19, 0x22, 0xde]);
}

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

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

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

    /* boolean allowStartDrag (in nsIDOMEvent event); */
    pub AllowStartDrag: unsafe extern "system" fn (this: *const nsIClipboardDragDropHooks, event: *const nsIDOMEvent, _retval: *mut bool) -> nsresult,

    /* boolean allowDrop (in nsIDOMEvent event, in nsIDragSession session); */
    pub AllowDrop: unsafe extern "system" fn (this: *const nsIClipboardDragDropHooks, event: *const nsIDOMEvent, session: *const nsIDragSession, _retval: *mut bool) -> nsresult,

    /* boolean onCopyOrDrag (in nsIDOMEvent aEvent, in nsITransferable trans); */
    pub OnCopyOrDrag: unsafe extern "system" fn (this: *const nsIClipboardDragDropHooks, aEvent: *const nsIDOMEvent, trans: *const nsITransferable, _retval: *mut bool) -> nsresult,

    /* boolean onPasteOrDrop (in nsIDOMEvent event, in nsITransferable trans); */
    pub OnPasteOrDrop: unsafe extern "system" fn (this: *const nsIClipboardDragDropHooks, event: *const nsIDOMEvent, trans: *const nsITransferable, _retval: *mut bool) -> 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 nsIClipboardDragDropHooks {

    /// ```text
    /// /**
    ///    * Prevents the drag from starting
    ///    *
    ///    * @param event DOM event (drag gesture)
    ///    *
    ///    * @return TRUE  drag can proceed
    ///    * @return FALSE drag is cancelled, does not go to OS
    ///    */
    /// ```
    ///

    /// `boolean allowStartDrag (in nsIDOMEvent event);`
    #[inline]
    pub unsafe fn AllowStartDrag(&self, event: *const nsIDOMEvent, _retval: *mut bool) -> nsresult {
        ((*self.vtable).AllowStartDrag)(self, event, _retval)
    }


    /// ```text
    /// /**
    ///    * Tells gecko whether a drop is allowed on this content area
    ///    *
    ///    * @param event   DOM event (drag over)
    ///    * @param session the drag session from which client can get
    ///    *                   the flavors present or the actual data
    ///    *
    ///    * @return TRUE  indicates to OS that if a drop does happen on this
    ///    *                browser, it will be accepted.
    ///    * @return FALSE indicates to OS drop is not allowed. On win32, this
    ///    *                will change the cursor to "reject".
    ///    */
    /// ```
    ///

    /// `boolean allowDrop (in nsIDOMEvent event, in nsIDragSession session);`
    #[inline]
    pub unsafe fn AllowDrop(&self, event: *const nsIDOMEvent, session: *const nsIDragSession, _retval: *mut bool) -> nsresult {
        ((*self.vtable).AllowDrop)(self, event, session, _retval)
    }


    /// ```text
    /// /**
    ///    * Alter the flavors or data presented to the OS
    ///    * Used for drag and copy actions
    ///    * Because this can be called many times, it is highly recommended
    ///    * that the implementation be very efficient so user feedback is
    ///    * not negatively impacted.
    ///    *
    ///    * @param event  DOM event (drag drop); null if triggered by copy.
    ///    * @param trans  the transferable holding the list of flavors
    ///    *               and the data for each flavor
    ///    *
    ///    * @return TRUE  copy/drag can proceed
    ///    * @return FALSE copy/drag is cancelled, does not go to OS
    ///    */
    /// ```
    ///

    /// `boolean onCopyOrDrag (in nsIDOMEvent aEvent, in nsITransferable trans);`
    #[inline]
    pub unsafe fn OnCopyOrDrag(&self, aEvent: *const nsIDOMEvent, trans: *const nsITransferable, _retval: *mut bool) -> nsresult {
        ((*self.vtable).OnCopyOrDrag)(self, aEvent, trans, _retval)
    }


    /// ```text
    /// /**
    ///    * Provide an alternative action to the built-in behavior when
    ///    * something is dropped on the browser or in an editor
    ///    *
    ///    * @param event  DOM event (drag drop); null if triggered by paste.
    ///    * @param trans  the transferable holding the list of flavors
    ///    *               and the data for each flavor
    ///    *
    ///    * @return TRUE  action was handled, do not perform built-in
    ///    *                behavior
    ///    * @return FALSE action was not overridden, do built-in behavior
    ///    */
    /// ```
    ///

    /// `boolean onPasteOrDrop (in nsIDOMEvent event, in nsITransferable trans);`
    #[inline]
    pub unsafe fn OnPasteOrDrop(&self, event: *const nsIDOMEvent, trans: *const nsITransferable, _retval: *mut bool) -> nsresult {
        ((*self.vtable).OnPasteOrDrop)(self, event, trans, _retval)
    }


}