pjs/webshell/public/nsIWebShell.h

152 строки
4.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsIWebShell_h___
#define nsIWebShell_h___
#include "nsIContentViewerContainer.h"
class nsIDocumentLoader;
class nsIURI;
// Interface ID for nsIWebShell
#define NS_IWEB_SHELL_IID \
{ 0xa6cf9058, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
// Interface ID for nsIWebShellContainer
#define NS_IWEB_SHELL_CONTAINER_IID \
{ 0xa6cf905a, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
// Class ID for an implementation of nsIWebShell
#define NS_WEB_SHELL_CID \
{ 0xa6cf9059, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
//----------------------------------------------------------------------
typedef enum {
nsLoadURL,
nsLoadHistory,
nsLoadLink,
nsLoadRefresh
} nsLoadType;
// Container for web shell's
class nsIWebShellContainer : public nsISupports {
public:
static const nsIID& GetIID() { static nsIID iid = NS_IWEB_SHELL_CONTAINER_IID; return iid; }
};
//----------------------------------------------------------------------
/**
* The web shell is a container for implementations of nsIContentViewer.
* It is a content-viewer-container and also knows how to delegate certain
* behavior to an nsIWebShellContainer.
*
* Web shells can be arranged in a tree.
*
* Web shells are also nsIWebShellContainer's because they can contain
* other web shells.
*/
class nsIWebShell : public nsIContentViewerContainer {
public:
static const nsIID& GetIID() { static nsIID iid = NS_IWEB_SHELL_IID; return iid; }
/**
* Set the nsIWebShellContainer for the WebShell.
*/
NS_IMETHOD SetContainer(nsIWebShellContainer* aContainer) = 0;
/**
* Return the current nsIWebShellContainer.
*/
NS_IMETHOD GetContainer(nsIWebShellContainer*& aResult) = 0;
/**
* Returns the top level window (this would be the containing window
* the same object that implements nsIWebShellContainer, nsIWebShellWindow).
*/
NS_IMETHOD GetTopLevelWindow(nsIWebShellContainer** aTopLevelWindow) = 0;
/**
* Return the root WebShell instance. Since WebShells can be nested
* (when frames are present for example) this instance represents the
* outermost WebShell.
*/
NS_IMETHOD GetRootWebShell(nsIWebShell*& aResult) = 0;
/**
* Get the referrer of the link using this WebShell.
*/
NS_IMETHOD GetReferrer(nsIURI **aReferrer) = 0;
//
// Document load api's
//
/**
* Return the nsIDocumentLoader associated with the WebShell.
*/
NS_IMETHOD GetDocumentLoader(nsIDocumentLoader*& aResult) = 0;
//
// History api's
//
/**
* Load the previous document in the history list.
*/
NS_IMETHOD GoTo(PRInt32 aHistoryIndex) = 0;
NS_IMETHOD GetHistoryLength(PRInt32& aResult) = 0;
NS_IMETHOD GetHistoryIndex(PRInt32& aResult) = 0;
NS_IMETHOD GetURL(PRInt32 aHistoryIndex, PRUnichar **aURLResult) = 0;
// SetToolBar
// SetMenuBar
// SetStatusBar
/**
* Finds text in content
*/
NS_IMETHOD FindNext(const PRUnichar * aSearchStr, PRBool aMatchCase, PRBool aSearchDown, PRBool &aIsFound) = 0;
/**
* Set the URL of the current WebShell.
*/
NS_IMETHOD SetURL(const PRUnichar* aURL) = 0;
};
#endif /* nsIWebShell_h___ */