/*

 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /src/mozilla-central/docshell/base/nsIWebNavigation.idl

 */

#ifndef __gen_nsIWebNavigation_h__

#define __gen_nsIWebNavigation_h__

#ifndef __gen_nsISupports_h__

#include "nsISupports.h"

#endif

#include "js/Value.h"

#include "js/GCAnnotations.h"

/* For IDL files that don't want to include root IDL files. */

#ifndef NS_NO_VTABLE

#define NS_NO_VTABLE

#endif

class nsIInputStream; /* forward declaration */

class nsISHistory; /* forward declaration */

class nsIURI; /* forward declaration */

class nsIPrincipal; /* forward declaration */

class nsIChildSHistory; /* forward declaration */

class nsIDocument; /* webidl Document */

#include "mozilla/dom/ChildSHistory.h"

/* starting interface:    nsIWebNavigation */

#define NS_IWEBNAVIGATION_IID_STR "3ade79d4-8cb9-4952-b18d-4f9b63ca0d31"

#define NS_IWEBNAVIGATION_IID \

  {0x3ade79d4, 0x8cb9, 0x4952, \

    { 0xb1, 0x8d, 0x4f, 0x9b, 0x63, 0xca, 0x0d, 0x31 }}

class nsIWebNavigation : public nsISupports {

 public:

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IWEBNAVIGATION_IID)

  /* readonly attribute boolean canGoBack; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetCanGoBack(bool *aCanGoBack) = 0;

  /* readonly attribute boolean canGoForward; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetCanGoForward(bool *aCanGoForward) = 0;

  /* void goBack (); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GoBack(void) = 0;

  /* void goForward (); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GoForward(void) = 0;

  /* void gotoIndex (in long index); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GotoIndex(int32_t index) = 0;

  enum {

    LOAD_FLAGS_MASK = 65535U,

    LOAD_FLAGS_NONE = 0U,

    LOAD_FLAGS_IS_REFRESH = 16U,

    LOAD_FLAGS_IS_LINK = 32U,

    LOAD_FLAGS_BYPASS_HISTORY = 64U,

    LOAD_FLAGS_REPLACE_HISTORY = 128U,

    LOAD_FLAGS_BYPASS_CACHE = 256U,

    LOAD_FLAGS_BYPASS_PROXY = 512U,

    LOAD_FLAGS_CHARSET_CHANGE = 1024U,

    LOAD_FLAGS_STOP_CONTENT = 2048U,

    LOAD_FLAGS_FROM_EXTERNAL = 4096U,

    LOAD_FLAGS_ALLOW_MIXED_CONTENT = 8192U,

    LOAD_FLAGS_FIRST_LOAD = 16384U,

    LOAD_FLAGS_ALLOW_POPUPS = 32768U,

    LOAD_FLAGS_BYPASS_CLASSIFIER = 65536U,

    LOAD_FLAGS_FORCE_ALLOW_COOKIES = 131072U,

    LOAD_FLAGS_DISALLOW_INHERIT_PRINCIPAL = 262144U,

    LOAD_FLAGS_ERROR_LOAD_CHANGES_RV = 524288U,

    LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP = 1048576U,

    LOAD_FLAGS_FIXUP_SCHEME_TYPOS = 2097152U,

    LOAD_FLAGS_FORCE_ALLOW_DATA_URI = 4194304U

  };

  /* void loadURI (in AString aURI, in unsigned long aLoadFlags, in nsIURI aReferrer, in nsIInputStream aPostData, in nsIInputStream aHeaders, [optional] in nsIPrincipal aTriggeringPrincipal); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD LoadURI(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIPrincipal *aTriggeringPrincipal) = 0;

  /* void loadURIWithOptions (in AString aURI, in unsigned long aLoadFlags, in nsIURI aReferrer, in unsigned long aReferrerPolicy, in nsIInputStream aPostData, in nsIInputStream aHeaders, in nsIURI aBaseURI, [optional] in nsIPrincipal aTriggeringPrincipal); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD LoadURIWithOptions(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, uint32_t aReferrerPolicy, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIURI *aBaseURI, nsIPrincipal *aTriggeringPrincipal) = 0;

  /* void reload (in unsigned long aReloadFlags); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD Reload(uint32_t aReloadFlags) = 0;

  enum {

    STOP_NETWORK = 1U,

    STOP_CONTENT = 2U,

    STOP_ALL = 3U

  };

  /* void stop (in unsigned long aStopFlags); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD Stop(uint32_t aStopFlags) = 0;

  /* readonly attribute Document document; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetDocument(nsIDocument **aDocument) = 0;

  /* readonly attribute nsIURI currentURI; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetCurrentURI(nsIURI **aCurrentURI) = 0;

  /* readonly attribute nsIURI referringURI; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetReferringURI(nsIURI **aReferringURI) = 0;

  /* [binaryname(SessionHistoryXPCOM)] readonly attribute nsISupports sessionHistory; */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetSessionHistoryXPCOM(nsISupports **aSessionHistory) = 0;

   /**

   * Get the session history object used by this nsIWebNavigation instance.

   * Use this method instead of the XPCOM method when getting the

   * SessionHistory from C++ code.

   */

  already_AddRefed<mozilla::dom::ChildSHistory>

  GetSessionHistory()

  {

    nsCOMPtr<nsISupports> history;

    GetSessionHistoryXPCOM(getter_AddRefs(history));

    return history.forget()

      .downcast<mozilla::dom::ChildSHistory>();

  }

    /* [implicit_jscontext] void setOriginAttributesBeforeLoading (in jsval originAttributes); */

  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD SetOriginAttributesBeforeLoading(JS::HandleValue originAttributes, JSContext* cx) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsIWebNavigation, NS_IWEBNAVIGATION_IID)

/* Use this macro when declaring classes that implement this interface. */

#define NS_DECL_NSIWEBNAVIGATION \

  NS_IMETHOD GetCanGoBack(bool *aCanGoBack) override; \

  NS_IMETHOD GetCanGoForward(bool *aCanGoForward) override; \

  NS_IMETHOD GoBack(void) override; \

  NS_IMETHOD GoForward(void) override; \

  NS_IMETHOD GotoIndex(int32_t index) override; \

  NS_IMETHOD LoadURI(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIPrincipal *aTriggeringPrincipal) override; \

  NS_IMETHOD LoadURIWithOptions(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, uint32_t aReferrerPolicy, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIURI *aBaseURI, nsIPrincipal *aTriggeringPrincipal) override; \

  NS_IMETHOD Reload(uint32_t aReloadFlags) override; \

  NS_IMETHOD Stop(uint32_t aStopFlags) override; \

  NS_IMETHOD GetDocument(nsIDocument **aDocument) override; \

  NS_IMETHOD GetCurrentURI(nsIURI **aCurrentURI) override; \

  NS_IMETHOD GetReferringURI(nsIURI **aReferringURI) override; \

  NS_IMETHOD GetSessionHistoryXPCOM(nsISupports **aSessionHistory) override; \

  NS_IMETHOD SetOriginAttributesBeforeLoading(JS::HandleValue originAttributes, JSContext* cx) override; 

/* Use this macro when declaring the members of this interface when the

   class doesn't implement the interface. This is useful for forwarding. */

#define NS_DECL_NON_VIRTUAL_NSIWEBNAVIGATION \

  nsresult GetCanGoBack(bool *aCanGoBack); \

  nsresult GetCanGoForward(bool *aCanGoForward); \

  nsresult GoBack(void); \

  nsresult GoForward(void); \

  nsresult GotoIndex(int32_t index); \

  nsresult LoadURI(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIPrincipal *aTriggeringPrincipal); \

  nsresult LoadURIWithOptions(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, uint32_t aReferrerPolicy, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIURI *aBaseURI, nsIPrincipal *aTriggeringPrincipal); \

  nsresult Reload(uint32_t aReloadFlags); \

  nsresult Stop(uint32_t aStopFlags); \

  nsresult GetDocument(nsIDocument **aDocument); \

  nsresult GetCurrentURI(nsIURI **aCurrentURI); \

  nsresult GetReferringURI(nsIURI **aReferringURI); \

  nsresult GetSessionHistoryXPCOM(nsISupports **aSessionHistory); \

  nsresult SetOriginAttributesBeforeLoading(JS::HandleValue originAttributes, JSContext* cx); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */

#define NS_FORWARD_NSIWEBNAVIGATION(_to) \

  NS_IMETHOD GetCanGoBack(bool *aCanGoBack) override { return _to GetCanGoBack(aCanGoBack); } \

  NS_IMETHOD GetCanGoForward(bool *aCanGoForward) override { return _to GetCanGoForward(aCanGoForward); } \

  NS_IMETHOD GoBack(void) override { return _to GoBack(); } \

  NS_IMETHOD GoForward(void) override { return _to GoForward(); } \

  NS_IMETHOD GotoIndex(int32_t index) override { return _to GotoIndex(index); } \

  NS_IMETHOD LoadURI(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIPrincipal *aTriggeringPrincipal) override { return _to LoadURI(aURI, aLoadFlags, aReferrer, aPostData, aHeaders, aTriggeringPrincipal); } \

  NS_IMETHOD LoadURIWithOptions(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, uint32_t aReferrerPolicy, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIURI *aBaseURI, nsIPrincipal *aTriggeringPrincipal) override { return _to LoadURIWithOptions(aURI, aLoadFlags, aReferrer, aReferrerPolicy, aPostData, aHeaders, aBaseURI, aTriggeringPrincipal); } \

  NS_IMETHOD Reload(uint32_t aReloadFlags) override { return _to Reload(aReloadFlags); } \

  NS_IMETHOD Stop(uint32_t aStopFlags) override { return _to Stop(aStopFlags); } \

  NS_IMETHOD GetDocument(nsIDocument **aDocument) override { return _to GetDocument(aDocument); } \

  NS_IMETHOD GetCurrentURI(nsIURI **aCurrentURI) override { return _to GetCurrentURI(aCurrentURI); } \

  NS_IMETHOD GetReferringURI(nsIURI **aReferringURI) override { return _to GetReferringURI(aReferringURI); } \

  NS_IMETHOD GetSessionHistoryXPCOM(nsISupports **aSessionHistory) override { return _to GetSessionHistoryXPCOM(aSessionHistory); } \

  NS_IMETHOD SetOriginAttributesBeforeLoading(JS::HandleValue originAttributes, JSContext* cx) override { return _to SetOriginAttributesBeforeLoading(originAttributes, cx); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */

#define NS_FORWARD_SAFE_NSIWEBNAVIGATION(_to) \

  NS_IMETHOD GetCanGoBack(bool *aCanGoBack) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCanGoBack(aCanGoBack); } \

  NS_IMETHOD GetCanGoForward(bool *aCanGoForward) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCanGoForward(aCanGoForward); } \

  NS_IMETHOD GoBack(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GoBack(); } \

  NS_IMETHOD GoForward(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GoForward(); } \

  NS_IMETHOD GotoIndex(int32_t index) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GotoIndex(index); } \

  NS_IMETHOD LoadURI(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIPrincipal *aTriggeringPrincipal) override { return !_to ? NS_ERROR_NULL_POINTER : _to->LoadURI(aURI, aLoadFlags, aReferrer, aPostData, aHeaders, aTriggeringPrincipal); } \

  NS_IMETHOD LoadURIWithOptions(const nsAString& aURI, uint32_t aLoadFlags, nsIURI *aReferrer, uint32_t aReferrerPolicy, nsIInputStream *aPostData, nsIInputStream *aHeaders, nsIURI *aBaseURI, nsIPrincipal *aTriggeringPrincipal) override { return !_to ? NS_ERROR_NULL_POINTER : _to->LoadURIWithOptions(aURI, aLoadFlags, aReferrer, aReferrerPolicy, aPostData, aHeaders, aBaseURI, aTriggeringPrincipal); } \

  NS_IMETHOD Reload(uint32_t aReloadFlags) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Reload(aReloadFlags); } \

  NS_IMETHOD Stop(uint32_t aStopFlags) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Stop(aStopFlags); } \

  NS_IMETHOD GetDocument(nsIDocument **aDocument) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDocument(aDocument); } \

  NS_IMETHOD GetCurrentURI(nsIURI **aCurrentURI) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCurrentURI(aCurrentURI); } \

  NS_IMETHOD GetReferringURI(nsIURI **aReferringURI) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetReferringURI(aReferringURI); } \

  NS_IMETHOD GetSessionHistoryXPCOM(nsISupports **aSessionHistory) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSessionHistoryXPCOM(aSessionHistory); } \

  NS_IMETHOD SetOriginAttributesBeforeLoading(JS::HandleValue originAttributes, JSContext* cx) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetOriginAttributesBeforeLoading(originAttributes, cx); } 

#endif /* __gen_nsIWebNavigation_h__ */