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


/// `interface nsIScrollable : nsISupports`
///

/// ```text
/// /**
///  * The nsIScrollable is an interface that can be implemented by a control that
///  * supports scrolling.  This is a generic interface without concern for the
///  * type of content that may be inside.
///  */
/// ```
///

// 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 nsIScrollable {
    vtable: *const nsIScrollableVTable,

    /// 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 nsIScrollable.
unsafe impl XpCom for nsIScrollable {
    const IID: nsIID = nsID(0x3507fc93, 0x313e, 0x4a4c,
        [0x8c, 0xa8, 0x4d, 0x0e, 0xa0, 0xf9, 0x73, 0x15]);
}

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

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

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

    /* long getDefaultScrollbarPreferences (in long scrollOrientation); */
    pub GetDefaultScrollbarPreferences: unsafe extern "system" fn (this: *const nsIScrollable, scrollOrientation: libc::int32_t, _retval: *mut libc::int32_t) -> nsresult,

    /* void setDefaultScrollbarPreferences (in long scrollOrientation, in long scrollbarPref); */
    pub SetDefaultScrollbarPreferences: unsafe extern "system" fn (this: *const nsIScrollable, scrollOrientation: libc::int32_t, scrollbarPref: libc::int32_t) -> nsresult,

    /* void getScrollbarVisibility (out boolean verticalVisible, out boolean horizontalVisible); */
    pub GetScrollbarVisibility: unsafe extern "system" fn (this: *const nsIScrollable, verticalVisible: *mut bool, horizontalVisible: *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 nsIScrollable {
    /// ```text
    /// /**
    ///    * Constants declaring the two scroll orientations a scrollbar can be in.
    ///    * ScrollOrientation_X - Horizontal scrolling.  When passing this
    ///    *         in to a method you are requesting or setting data for the
    ///    *         horizontal scrollbar.
    ///    * ScrollOrientation_Y - Vertical scrolling.  When passing this
    ///    *         in to a method you are requesting or setting data for the
    ///    *         vertical scrollbar.
    ///    */
    /// ```
    ///

    pub const ScrollOrientation_X: i64 = 1;


    pub const ScrollOrientation_Y: i64 = 2;

    /// ```text
    /// /**
    ///    * Constants declaring the states of the scrollbars.
    ///    * ScrollPref_Auto - bars visible only when needed.
    ///    * ScrollPref_Never - bars never visible, even when scrolling still possible.
    ///    * ScrollPref_Always - bars always visible, even when scrolling is not possible
    ///    */
    /// ```
    ///

    pub const Scrollbar_Auto: i64 = 1;


    pub const Scrollbar_Never: i64 = 2;


    pub const Scrollbar_Always: i64 = 3;

    /// ```text
    /// /**
    ///    * Get or set the default scrollbar state for all documents in
    ///    * this shell.
    ///    */
    /// ```
    ///

    /// `long getDefaultScrollbarPreferences (in long scrollOrientation);`
    #[inline]
    pub unsafe fn GetDefaultScrollbarPreferences(&self, scrollOrientation: libc::int32_t, _retval: *mut libc::int32_t) -> nsresult {
        ((*self.vtable).GetDefaultScrollbarPreferences)(self, scrollOrientation, _retval)
    }



    /// `void setDefaultScrollbarPreferences (in long scrollOrientation, in long scrollbarPref);`
    #[inline]
    pub unsafe fn SetDefaultScrollbarPreferences(&self, scrollOrientation: libc::int32_t, scrollbarPref: libc::int32_t) -> nsresult {
        ((*self.vtable).SetDefaultScrollbarPreferences)(self, scrollOrientation, scrollbarPref)
    }


    /// ```text
    /// /**
    ///    * Get information about whether the vertical and horizontal scrollbars are
    ///    * currently visible.  If you are only interested in one of the visibility
    ///    * settings pass nullptr in for the one you aren't interested in.
    ///    */
    /// ```
    ///

    /// `void getScrollbarVisibility (out boolean verticalVisible, out boolean horizontalVisible);`
    #[inline]
    pub unsafe fn GetScrollbarVisibility(&self, verticalVisible: *mut bool, horizontalVisible: *mut bool) -> nsresult {
        ((*self.vtable).GetScrollbarVisibility)(self, verticalVisible, horizontalVisible)
    }


}