gecko/dom/base/nsHistory.h
2013-08-09 23:47:59 -07:00

76 lines
2.8 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 sw=2 et tw=79: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsHistory_h___
#define nsHistory_h___
#include "mozilla/Attributes.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/dom/BindingUtils.h"
#include "nsCycleCollectionParticipant.h"
#include "nsWrapperCache.h"
#include "nsIDOMHistory.h"
#include "nsString.h"
#include "nsISHistory.h"
#include "nsIWeakReference.h"
#include "nsPIDOMWindow.h"
class nsIDocShell;
// Script "History" object
class nsHistory MOZ_FINAL : public nsIDOMHistory, // Empty, needed for extension
// backwards compat
public nsWrapperCache
{
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsHistory)
public:
nsHistory(nsPIDOMWindow* aInnerWindow);
virtual ~nsHistory();
nsPIDOMWindow* GetParentObject() const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aScope) MOZ_OVERRIDE;
uint32_t GetLength(mozilla::ErrorResult& aRv) const;
JS::Value GetState(JSContext* aCx, mozilla::ErrorResult& aRv) const;
void Go(int32_t aDelta, mozilla::ErrorResult& aRv);
void Back(mozilla::ErrorResult& aRv);
void Forward(mozilla::ErrorResult& aRv);
void PushState(JSContext* aCx, JS::Handle<JS::Value> aData,
const nsAString& aTitle, const nsAString& aUrl,
mozilla::ErrorResult& aRv);
void ReplaceState(JSContext* aCx, JS::Handle<JS::Value> aData,
const nsAString& aTitle, const nsAString& aUrl,
mozilla::ErrorResult& aRv);
void GetCurrent(nsString& aRetval, mozilla::ErrorResult& aRv) const;
void GetPrevious(nsString& aRetval, mozilla::ErrorResult& aRv) const;
void GetNext(nsString& aRetval, mozilla::ErrorResult& aRv) const;
void Item(uint32_t aIndex, nsString& aRetval, mozilla::ErrorResult& aRv);
void IndexedGetter(uint32_t aIndex, bool &aFound, nsString& aRetval,
mozilla::ErrorResult& aRv);
uint32_t Length();
protected:
nsIDocShell *GetDocShell() const {
nsCOMPtr<nsPIDOMWindow> win(do_QueryReferent(mInnerWindow));
if (!win)
return nullptr;
return win->GetDocShell();
}
void PushOrReplaceState(JSContext* aCx, JS::Value aData,
const nsAString& aTitle, const nsAString& aUrl,
mozilla::ErrorResult& aRv, bool aReplace);
already_AddRefed<nsISHistory> GetSessionHistory() const;
nsCOMPtr<nsIWeakReference> mInnerWindow;
};
#endif /* nsHistory_h___ */