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


/// `interface nsIAboutNewTabService : nsISupports`
///

/// ```text
/// /**
///  * Allows to override about:newtab to point to a different location
///  * than the one specified within AboutRedirector.cpp
///  */
/// ```
///

// 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 nsIAboutNewTabService {
    vtable: *const nsIAboutNewTabServiceVTable,

    /// 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 nsIAboutNewTabService.
unsafe impl XpCom for nsIAboutNewTabService {
    const IID: nsIID = nsID(0xdfcd2adc, 0x7867, 0x4d3a,
        [0xba, 0x70, 0x17, 0x50, 0x1f, 0x20, 0x81, 0x42]);
}

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

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

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

    /* attribute ACString newTabURL; */
    pub GetNewTabURL: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aNewTabURL: &mut ::nsstring::nsACString) -> nsresult,

    /* attribute ACString newTabURL; */
    pub SetNewTabURL: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aNewTabURL: &::nsstring::nsACString) -> nsresult,

    /* attribute ACString defaultURL; */
    pub GetDefaultURL: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aDefaultURL: &mut ::nsstring::nsACString) -> nsresult,

    /* attribute ACString defaultURL; */
    pub SetDefaultURL: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aDefaultURL: &::nsstring::nsACString) -> nsresult,

    /* attribute bool willNotifyUser; */
    pub GetWillNotifyUser: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aWillNotifyUser: *mut bool) -> nsresult,

    /* attribute bool willNotifyUser; */
    pub SetWillNotifyUser: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aWillNotifyUser: bool) -> nsresult,

    /* readonly attribute bool overridden; */
    pub GetOverridden: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aOverridden: *mut bool) -> nsresult,

    /* readonly attribute bool activityStreamEnabled; */
    pub GetActivityStreamEnabled: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aActivityStreamEnabled: *mut bool) -> nsresult,

    /* readonly attribute bool activityStreamPrerender; */
    pub GetActivityStreamPrerender: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aActivityStreamPrerender: *mut bool) -> nsresult,

    /* readonly attribute bool activityStreamDebug; */
    pub GetActivityStreamDebug: unsafe extern "system" fn (this: *const nsIAboutNewTabService, aActivityStreamDebug: *mut bool) -> nsresult,

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

    /// ```text
    /// /**
    ///    * Returns the url of the resource for the newtab page if not overridden,
    ///    * otherwise a string represenation of the new URL.
    ///    */
    /// ```
    ///

    /// `attribute ACString newTabURL;`
    #[inline]
    pub unsafe fn GetNewTabURL(&self, aNewTabURL: &mut ::nsstring::nsACString) -> nsresult {
        ((*self.vtable).GetNewTabURL)(self, aNewTabURL)
    }


    /// ```text
    /// /**
    ///    * Returns the url of the resource for the newtab page if not overridden,
    ///    * otherwise a string represenation of the new URL.
    ///    */
    /// ```
    ///

    /// `attribute ACString newTabURL;`
    #[inline]
    pub unsafe fn SetNewTabURL(&self, aNewTabURL: &::nsstring::nsACString) -> nsresult {
        ((*self.vtable).SetNewTabURL)(self, aNewTabURL)
    }


    /// ```text
    /// /**
    ///    * Returns the default URL (local or activity stream depending on pref)
    ///    */
    /// ```
    ///

    /// `attribute ACString defaultURL;`
    #[inline]
    pub unsafe fn GetDefaultURL(&self, aDefaultURL: &mut ::nsstring::nsACString) -> nsresult {
        ((*self.vtable).GetDefaultURL)(self, aDefaultURL)
    }


    /// ```text
    /// /**
    ///    * Returns the default URL (local or activity stream depending on pref)
    ///    */
    /// ```
    ///

    /// `attribute ACString defaultURL;`
    #[inline]
    pub unsafe fn SetDefaultURL(&self, aDefaultURL: &::nsstring::nsACString) -> nsresult {
        ((*self.vtable).SetDefaultURL)(self, aDefaultURL)
    }


    /// ```text
    /// /**
    ///    * Returns true if opening the New Tab page will notify the user of a change.
    ///    */
    /// ```
    ///

    /// `attribute bool willNotifyUser;`
    #[inline]
    pub unsafe fn GetWillNotifyUser(&self, aWillNotifyUser: *mut bool) -> nsresult {
        ((*self.vtable).GetWillNotifyUser)(self, aWillNotifyUser)
    }


    /// ```text
    /// /**
    ///    * Returns true if opening the New Tab page will notify the user of a change.
    ///    */
    /// ```
    ///

    /// `attribute bool willNotifyUser;`
    #[inline]
    pub unsafe fn SetWillNotifyUser(&self, aWillNotifyUser: bool) -> nsresult {
        ((*self.vtable).SetWillNotifyUser)(self, aWillNotifyUser)
    }


    /// ```text
    /// /**
    ///    * Returns true if the default resource got overridden.
    ///    */
    /// ```
    ///

    /// `readonly attribute bool overridden;`
    #[inline]
    pub unsafe fn GetOverridden(&self, aOverridden: *mut bool) -> nsresult {
        ((*self.vtable).GetOverridden)(self, aOverridden)
    }


    /// ```text
    /// /**
    ///    * Returns true if the default resource is activity stream and isn't
    ///    * overridden
    ///    */
    /// ```
    ///

    /// `readonly attribute bool activityStreamEnabled;`
    #[inline]
    pub unsafe fn GetActivityStreamEnabled(&self, aActivityStreamEnabled: *mut bool) -> nsresult {
        ((*self.vtable).GetActivityStreamEnabled)(self, aActivityStreamEnabled)
    }


    /// ```text
    /// /**
    ///    * Returns true if the the prerendering pref for activity stream is true
    ///    */
    /// ```
    ///

    /// `readonly attribute bool activityStreamPrerender;`
    #[inline]
    pub unsafe fn GetActivityStreamPrerender(&self, aActivityStreamPrerender: *mut bool) -> nsresult {
        ((*self.vtable).GetActivityStreamPrerender)(self, aActivityStreamPrerender)
    }


    /// ```text
    /// /**
    ///    * Returns true if the the debug pref for activity stream is true
    ///    */
    /// ```
    ///

    /// `readonly attribute bool activityStreamDebug;`
    #[inline]
    pub unsafe fn GetActivityStreamDebug(&self, aActivityStreamDebug: *mut bool) -> nsresult {
        ((*self.vtable).GetActivityStreamDebug)(self, aActivityStreamDebug)
    }


    /// ```text
    /// /**
    ///    * Resets to the default resource and also resets the
    ///    * overridden attribute to false.
    ///    */
    /// ```
    ///

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


}