docshell/base/nsGlobalHistoryAdapter.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla gecko code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Benjamin Smedberg <bsmedberg@covad.net>
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsIGlobalHistory2.h"
  39 #include "nsIGlobalHistory.h"
  40 #include "nsIGenericFactory.h"
  41 #include "nsCOMPtr.h"
  42
  43 /**
  44  * A compatibility wrapper for the old nsIGlobalHistory interface. It provides
  45  * the new nsIGlobalHistory2 interface for embedders who haven't implemented it
  46  * themselves.
  47  */
  48
  49 // {2e9b69dd-9087-438c-8b5d-f77b553abefb}
  50 #define NS_GLOBALHISTORYADAPTER_CID \
  51  { 0x2e9b69dd, 0x9087, 0x438c, { 0x8b, 0x5d, 0xf7, 0x7b, 0x55, 0x3a, 0xbe, 0xfb } }
  52
  53 class nsGlobalHistoryAdapter : public nsIGlobalHistory2
  54 {
  55 public:
  56   NS_DECL_ISUPPORTS
  57   NS_DECL_NSIGLOBALHISTORY2
  58
  59   static NS_METHOD Create(nsISupports *aOuter,
  60                           REFNSIID aIID,
  61                           void **aResult);
  62
  63   static NS_METHOD RegisterSelf(nsIComponentManager* aCompMgr,
  64                                 nsIFile* aPath,
  65                                 const char* aLoaderStr,
  66                                 const char* aType,
  67                                 const nsModuleComponentInfo *aInfo);
  68
  69   NS_DEFINE_STATIC_CID_ACCESSOR(NS_GLOBALHISTORYADAPTER_CID)
  70
  71 private:
  72   nsGlobalHistoryAdapter();
  73   ~nsGlobalHistoryAdapter();
  74
  75   nsresult Init();
  76   nsCOMPtr<nsIGlobalHistory> mHistory;
  77 };