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


/// `interface nsIFeedTextConstruct : nsISupports`
///

/// ```text
/// /**
///  * nsIFeedTextConstructs represent feed text fields that can contain
///  * one of text, HTML, or XHTML. Some extension elements also have "type"
///  * parameters, and this interface could be used there as well.
///  */
/// ```
///

// 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 nsIFeedTextConstruct {
    vtable: *const nsIFeedTextConstructVTable,

    /// 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 nsIFeedTextConstruct.
unsafe impl XpCom for nsIFeedTextConstruct {
    const IID: nsIID = nsID(0xfc97a2a9, 0xd649, 0x4494,
        [0x93, 0x1e, 0xdb, 0x81, 0xa1, 0x56, 0xc8, 0x73]);
}

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

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

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

    /* attribute nsIURI base; */
    pub GetBase: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aBase: *mut *const nsIURI) -> nsresult,

    /* attribute nsIURI base; */
    pub SetBase: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aBase: *const nsIURI) -> nsresult,

    /* attribute AString lang; */
    pub GetLang: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aLang: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString lang; */
    pub SetLang: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aLang: &::nsstring::nsAString) -> nsresult,

    /* attribute AString type; */
    pub GetType: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aType: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString type; */
    pub SetType: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aType: &::nsstring::nsAString) -> nsresult,

    /* attribute AString text; */
    pub GetText: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aText: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString text; */
    pub SetText: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, aText: &::nsstring::nsAString) -> nsresult,

    /* AString plainText (); */
    pub PlainText: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, _retval: &mut ::nsstring::nsAString) -> nsresult,

    /* nsIDOMDocumentFragment createDocumentFragment (in nsIDOMElement element); */
    pub CreateDocumentFragment: unsafe extern "system" fn (this: *const nsIFeedTextConstruct, element: *const nsIDOMElement, _retval: *mut *const nsIDOMDocumentFragment) -> 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 nsIFeedTextConstruct {

    /// ```text
    /// /**
    ///    * If the text construct contains (X)HTML, relative references in
    ///    * the content should be resolved against this base URI.
    ///    */
    /// ```
    ///

    /// `attribute nsIURI base;`
    #[inline]
    pub unsafe fn GetBase(&self, aBase: *mut *const nsIURI) -> nsresult {
        ((*self.vtable).GetBase)(self, aBase)
    }


    /// ```text
    /// /**
    ///    * If the text construct contains (X)HTML, relative references in
    ///    * the content should be resolved against this base URI.
    ///    */
    /// ```
    ///

    /// `attribute nsIURI base;`
    #[inline]
    pub unsafe fn SetBase(&self, aBase: *const nsIURI) -> nsresult {
        ((*self.vtable).SetBase)(self, aBase)
    }


    /// ```text
    /// /**
    ///    * The language of the text. For example, "en-US" for US English.
    ///    */
    /// ```
    ///

    /// `attribute AString lang;`
    #[inline]
    pub unsafe fn GetLang(&self, aLang: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetLang)(self, aLang)
    }


    /// ```text
    /// /**
    ///    * The language of the text. For example, "en-US" for US English.
    ///    */
    /// ```
    ///

    /// `attribute AString lang;`
    #[inline]
    pub unsafe fn SetLang(&self, aLang: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetLang)(self, aLang)
    }


    /// ```text
    /// /**
    ///    * One of "text", "html", or "xhtml". If the type is (x)html, a '<'
    ///    * character represents markup. To display that character, an escape
    ///    * such as &lt; must be used. If the type is "text", the '<'
    ///    * character represents the character itself, and such text should
    ///    * not be embedded in markup without escaping it first.
    ///    */
    /// ```
    ///

    /// `attribute AString type;`
    #[inline]
    pub unsafe fn GetType(&self, aType: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetType)(self, aType)
    }


    /// ```text
    /// /**
    ///    * One of "text", "html", or "xhtml". If the type is (x)html, a '<'
    ///    * character represents markup. To display that character, an escape
    ///    * such as &lt; must be used. If the type is "text", the '<'
    ///    * character represents the character itself, and such text should
    ///    * not be embedded in markup without escaping it first.
    ///    */
    /// ```
    ///

    /// `attribute AString type;`
    #[inline]
    pub unsafe fn SetType(&self, aType: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetType)(self, aType)
    }


    /// ```text
    /// /**
    ///    * The content of the text construct.
    ///    */
    /// ```
    ///

    /// `attribute AString text;`
    #[inline]
    pub unsafe fn GetText(&self, aText: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetText)(self, aText)
    }


    /// ```text
    /// /**
    ///    * The content of the text construct.
    ///    */
    /// ```
    ///

    /// `attribute AString text;`
    #[inline]
    pub unsafe fn SetText(&self, aText: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetText)(self, aText)
    }


    /// ```text
    /// /**
    ///    * Returns the text of the text construct, with all markup stripped
    ///    * and all entities decoded. If the type attribute's value is "text",
    ///    * this function returns the value of the text attribute unchanged.
    ///    */
    /// ```
    ///

    /// `AString plainText ();`
    #[inline]
    pub unsafe fn PlainText(&self, _retval: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).PlainText)(self, _retval)
    }


    /// ```text
    /// /**
    ///    * Return an nsIDocumentFragment containing the text and markup.
    ///    */
    /// ```
    ///

    /// `nsIDOMDocumentFragment createDocumentFragment (in nsIDOMElement element);`
    #[inline]
    pub unsafe fn CreateDocumentFragment(&self, element: *const nsIDOMElement, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult {
        ((*self.vtable).CreateDocumentFragment)(self, element, _retval)
    }


}