docshell/shistory/public/nsISHTransaction.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Radha Kulkarni <radha@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsISHEntry.idl"
  42 #include "nsIEnumerator.idl"
  43
  44
  45 /**
  46  * The nsISHTransaction.
  47  */
  48
  49
  50 [scriptable, uuid(2EDF705F-D252-4971-9F09-71DD0F760DC6)]
  51 interface nsISHTransaction : nsISupports
  52 {
  53         /**
  54      * The nsISHEntry for the current transaction
  55      */
  56         attribute nsISHEntry sHEntry;
  57
  58         /**
  59          * The parent of this transaction
  60          */
  61         attribute nsISHTransaction prev;
  62
  63         /**
  64          * The legitimate child of this transaction
  65          */
  66         attribute nsISHTransaction next;
  67
  68         /**
  69          *      Specifies if this transaction should persist.  If not it will be replaced
  70          * by new additions to the list.
  71          */
  72         attribute boolean persist;
  73
  74         /**
  75          * Create a transaction with parent and History Entry
  76          */
  77          void create(in nsISHEntry aSHEntry, in nsISHTransaction aPrev);
  78 };
  79
  80 %{ C++
  81 // {BFD1A792-AD9F-11d3-BDC7-0050040A9B44}
  82
  83
  84 #define NS_SHTRANSACTION_CID \
  85 {0xbfd1a792, 0xad9f, 0x11d3, {0xbd, 0xc7, 0x0, 0x50, 0x4, 0xa, 0x9b, 0x44}}
  86
  87 #define NS_SHTRANSACTION_CONTRACTID \
  88     "@mozilla.org/browser/session-history-transaction;1"
  89
  90 %}