Back to index

lightning-sunbird  0.9+nobinonly
nsIWebNavigation.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  * ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Mozilla browser.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications, Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Travis Bogard <travis@netscape.com>
00024  *   Darin Fisher <darin@meer.net>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00042 interface nsIDOMDocument;
00043 interface nsIInputStream;
00044 interface nsISHistory;
00045 interface nsIURI;
00046 
00055 [scriptable, uuid(F5D9E7B0-D930-11d3-B057-00A024FFC08C)]
00056 interface nsIWebNavigation : nsISupports
00057 {
00062   readonly attribute boolean canGoBack;
00063 
00068   readonly attribute boolean canGoForward;
00069 
00080   void goBack();
00081 
00092   void goForward();
00093 
00101   void gotoIndex(in long index);
00102 
00103   /****************************************************************************
00104    * The following flags may be bitwise combined to form the load flags
00105    * parameter passed to either the loadURI or reload method.  Some of these
00106    * flags are only applicable to loadURI.
00107    */
00108 
00112   const unsigned long LOAD_FLAGS_MASK            = 0xffff;
00113 
00117   const unsigned long LOAD_FLAGS_NONE            = 0x0000;
00118 
00125   const unsigned long LOAD_FLAGS_IS_REFRESH      = 0x0010;
00126 
00132   const unsigned long LOAD_FLAGS_IS_LINK         = 0x0020;
00133 
00138   const unsigned long LOAD_FLAGS_BYPASS_HISTORY  = 0x0040;
00139 
00144   const unsigned long LOAD_FLAGS_REPLACE_HISTORY = 0x0080;
00145 
00150   const unsigned long LOAD_FLAGS_BYPASS_CACHE    = 0x0100;
00151 
00156   const unsigned long LOAD_FLAGS_BYPASS_PROXY    = 0x0200;
00157 
00163   const unsigned long LOAD_FLAGS_CHARSET_CHANGE  = 0x0400;
00164  
00171   const unsigned long LOAD_FLAGS_STOP_CONTENT    = 0x0800;
00172 
00176   const unsigned long LOAD_FLAGS_FROM_EXTERNAL   = 0x1000;
00177   
00183   const unsigned long LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP = 0x2000;
00184 
00191   const unsigned long LOAD_FLAGS_FIRST_LOAD = 0x4000;
00192 
00224   void loadURI(in wstring        aURI,
00225                in unsigned long  aLoadFlags,
00226                in nsIURI         aReferrer,
00227                in nsIInputStream aPostData,
00228                in nsIInputStream aHeaders);
00229 
00244   void reload(in unsigned long aReloadFlags);
00245 
00246   /****************************************************************************
00247    * The following flags may be passed as the stop flags parameter to the stop
00248    * method defined on this interface.
00249    */
00250 
00255   const unsigned long STOP_NETWORK = 0x01;
00256 
00261   const unsigned long STOP_CONTENT = 0x02;
00262 
00266   const unsigned long STOP_ALL     = 0x03;
00267 
00274   void stop(in unsigned long aStopFlags);
00275 
00281   readonly attribute nsIDOMDocument document;
00282 
00286   readonly attribute nsIURI currentURI;
00287  
00291   readonly attribute nsIURI referringURI;
00292 
00296   attribute nsISHistory sessionHistory;
00297 };