ghcjs-dom-javascript-0.10.0.0: src/GHCJS/DOM/JSFFI/Generated/Navigation.hs

{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE ForeignFunctionInterface, JavaScriptFFI #-}
{-# LANGUAGE ImplicitParams, ConstraintKinds, KindSignatures #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
-- | Generated by dom-gen from html (webref). Do not edit.
module GHCJS.DOM.JSFFI.Generated.Navigation
       (js_back, js_entries, js_forward, js_navigate, js_reload, js_traverseTo, js_updateCurrentEntry, js_getCurrentEntry, js_getTransition, js_getActivation, js_getCanGoBack, js_getCanGoForward, back, back_, entries, entries_, forward, forward_, navigate, navigate_, reload, reload_, traverseTo, traverseTo_, updateCurrentEntry, getCurrentEntry, getCurrentEntryUnsafe, getCurrentEntryUnchecked, getTransition, getTransitionUnsafe, getTransitionUnchecked, getActivation, getActivationUnsafe, getActivationUnchecked, getCanGoBack, getCanGoForward, navigateEvent, navigatesuccess, navigateerror, currententrychange, Navigation(..), gTypeNavigation)
       where
import Prelude ((.), (==), (>>=), (<$>), (++), Bool(..), Maybe(..), IO, Int, Word, Double, Float)
import qualified Prelude as P
import Control.Monad (void)
import GHCJS.Types (JSVal, JSString)
import GHCJS.Foreign (jsUndefined, jsNull)
import GHCJS.DOM.Types
import qualified GHCJS.DOM.Types as Types
import GHCJS.DOM.EventTargetClosures (EventName, unsafeEventName, unsafeEventNameAsync)
import GHCJS.DOM.JSFFI.Generated.Enums

foreign import javascript safe "(($1, $2) => { return $1[\"back\"]($2); })"
        js_back :: Navigation -> JSVal -> IO NavigationResult
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/back MDN Navigation.back documentation>
back :: (MonadDOM m, IsNavigationOptions options) => Navigation -> Maybe options -> m NavigationResult
back self options = liftDOM (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_back (self) a2'))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/back MDN Navigation.back documentation>
back_ :: (MonadDOM m, IsNavigationOptions options) => Navigation -> Maybe options -> m ()
back_ self options = liftDOM (void (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_back (self) a2')))

foreign import javascript safe "(($1) => { return $1[\"entries\"](); })"
        js_entries :: Navigation -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/entries MDN Navigation.entries documentation>
entries :: (MonadDOM m) => Navigation -> m [NavigationHistoryEntry]
entries self = liftDOM (((js_entries (self)) >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/entries MDN Navigation.entries documentation>
entries_ :: (MonadDOM m) => Navigation -> m ()
entries_ self = liftDOM (void ((js_entries (self))))

foreign import javascript safe "(($1, $2) => { return $1[\"forward\"]($2); })"
        js_forward :: Navigation -> JSVal -> IO NavigationResult
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/forward MDN Navigation.forward documentation>
forward :: (MonadDOM m, IsNavigationOptions options) => Navigation -> Maybe options -> m NavigationResult
forward self options = liftDOM (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_forward (self) a2'))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/forward MDN Navigation.forward documentation>
forward_ :: (MonadDOM m, IsNavigationOptions options) => Navigation -> Maybe options -> m ()
forward_ self options = liftDOM (void (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_forward (self) a2')))

foreign import javascript safe "(($1, $2, $3) => { return $1[\"navigate\"]($2, $3); })"
        js_navigate :: Navigation -> JSString -> JSVal -> IO NavigationResult
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/navigate MDN Navigation.navigate documentation>
navigate :: (MonadDOM m, ToJSString url) => Navigation -> url -> Maybe NavigationNavigateOptions -> m NavigationResult
navigate self url options = liftDOM (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a3' -> js_navigate (self) (toJSString url) a3'))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/navigate MDN Navigation.navigate documentation>
navigate_ :: (MonadDOM m, ToJSString url) => Navigation -> url -> Maybe NavigationNavigateOptions -> m ()
navigate_ self url options = liftDOM (void (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a3' -> js_navigate (self) (toJSString url) a3')))

foreign import javascript safe "(($1, $2) => { return $1[\"reload\"]($2); })"
        js_reload :: Navigation -> JSVal -> IO NavigationResult
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/reload MDN Navigation.reload documentation>
reload :: (MonadDOM m) => Navigation -> Maybe NavigationReloadOptions -> m NavigationResult
reload self options = liftDOM (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_reload (self) a2'))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/reload MDN Navigation.reload documentation>
reload_ :: (MonadDOM m) => Navigation -> Maybe NavigationReloadOptions -> m ()
reload_ self options = liftDOM (void (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a2' -> js_reload (self) a2')))

foreign import javascript safe "(($1, $2, $3) => { return $1[\"traverseTo\"]($2, $3); })"
        js_traverseTo :: Navigation -> JSString -> JSVal -> IO NavigationResult
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/traverseTo MDN Navigation.traverseTo documentation>
traverseTo :: (MonadDOM m, ToJSString key, IsNavigationOptions options) => Navigation -> key -> Maybe options -> m NavigationResult
traverseTo self key options = liftDOM (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a3' -> js_traverseTo (self) (toJSString key) a3'))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/traverseTo MDN Navigation.traverseTo documentation>
traverseTo_ :: (MonadDOM m, ToJSString key, IsNavigationOptions options) => Navigation -> key -> Maybe options -> m ()
traverseTo_ self key options = liftDOM (void (((P.maybe (P.return jsUndefined) toJSVal options) >>= \a3' -> js_traverseTo (self) (toJSString key) a3')))

foreign import javascript safe "(($1, $2) => { return $1[\"updateCurrentEntry\"]($2); })"
        js_updateCurrentEntry :: Navigation -> NavigationUpdateCurrentEntryOptions -> IO ()
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/updateCurrentEntry MDN Navigation.updateCurrentEntry documentation>
updateCurrentEntry :: (MonadDOM m) => Navigation -> NavigationUpdateCurrentEntryOptions -> m ()
updateCurrentEntry self options = liftDOM (void ((js_updateCurrentEntry (self) (options))))

foreign import javascript unsafe "(($1) => { return $1[\"currentEntry\"]; })"
        js_getCurrentEntry :: Navigation -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/currentEntry MDN Navigation.currentEntry documentation>
getCurrentEntry :: (MonadDOM m) => Navigation -> m (Maybe NavigationHistoryEntry)
getCurrentEntry self = liftDOM (((js_getCurrentEntry (self)) >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/currentEntry MDN Navigation.currentEntry documentation>
getCurrentEntryUnsafe :: (MonadDOM m, HasCallStack) => Navigation -> m NavigationHistoryEntry
getCurrentEntryUnsafe self = liftDOM ((((js_getCurrentEntry (self)) >>= fromJSValUnchecked) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/currentEntry MDN Navigation.currentEntry documentation>
getCurrentEntryUnchecked :: (MonadDOM m) => Navigation -> m NavigationHistoryEntry
getCurrentEntryUnchecked self = liftDOM ((pFromJSVal <$> (js_getCurrentEntry (self))))

foreign import javascript unsafe "(($1) => { return $1[\"transition\"]; })"
        js_getTransition :: Navigation -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/transition MDN Navigation.transition documentation>
getTransition :: (MonadDOM m) => Navigation -> m (Maybe NavigationTransition)
getTransition self = liftDOM (((js_getTransition (self)) >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/transition MDN Navigation.transition documentation>
getTransitionUnsafe :: (MonadDOM m, HasCallStack) => Navigation -> m NavigationTransition
getTransitionUnsafe self = liftDOM ((((js_getTransition (self)) >>= fromJSValUnchecked) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/transition MDN Navigation.transition documentation>
getTransitionUnchecked :: (MonadDOM m) => Navigation -> m NavigationTransition
getTransitionUnchecked self = liftDOM ((pFromJSVal <$> (js_getTransition (self))))

foreign import javascript unsafe "(($1) => { return $1[\"activation\"]; })"
        js_getActivation :: Navigation -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/activation MDN Navigation.activation documentation>
getActivation :: (MonadDOM m) => Navigation -> m (Maybe NavigationActivation)
getActivation self = liftDOM (((js_getActivation (self)) >>= fromJSValUnchecked))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/activation MDN Navigation.activation documentation>
getActivationUnsafe :: (MonadDOM m, HasCallStack) => Navigation -> m NavigationActivation
getActivationUnsafe self = liftDOM ((((js_getActivation (self)) >>= fromJSValUnchecked) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/Navigation/activation MDN Navigation.activation documentation>
getActivationUnchecked :: (MonadDOM m) => Navigation -> m NavigationActivation
getActivationUnchecked self = liftDOM ((pFromJSVal <$> (js_getActivation (self))))

foreign import javascript unsafe "(($1) => { return $1[\"canGoBack\"]; })"
        js_getCanGoBack :: Navigation -> IO Bool
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/canGoBack MDN Navigation.canGoBack documentation>
getCanGoBack :: (MonadDOM m) => Navigation -> m Bool
getCanGoBack self = liftDOM ((js_getCanGoBack (self)))

foreign import javascript unsafe "(($1) => { return $1[\"canGoForward\"]; })"
        js_getCanGoForward :: Navigation -> IO Bool
-- | <https://developer.mozilla.org/docs/Web/API/Navigation/canGoForward MDN Navigation.canGoForward documentation>
getCanGoForward :: (MonadDOM m) => Navigation -> m Bool
getCanGoForward self = liftDOM ((js_getCanGoForward (self)))

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigation-onnavigate navigate event>
navigateEvent :: EventName Navigation NavigateEvent
navigateEvent = unsafeEventName (toJSString "navigate")

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigation-onnavigatesuccess navigatesuccess event>
navigatesuccess :: EventName Navigation Event
navigatesuccess = unsafeEventName (toJSString "navigatesuccess")

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigation-onnavigateerror navigateerror event>
navigateerror :: EventName Navigation ErrorEvent
navigateerror = unsafeEventName (toJSString "navigateerror")

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigation-oncurrententrychange currententrychange event>
currententrychange :: EventName Navigation NavigationCurrentEntryChangeEvent
currententrychange = unsafeEventName (toJSString "currententrychange")