Back to index

lightning-sunbird  0.9+nobinonly
nsILinkHandler.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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 Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 #ifndef nsILinkHandler_h___
00038 #define nsILinkHandler_h___
00039 
00040 #include "nsISupports.h"
00041 
00042 class nsIInputStream;
00043 class nsIDocShell;
00044 class nsIRequest;
00045 class nsIContent;
00046 class nsString;
00047 class nsGUIEvent;
00048 
00049 // Interface ID for nsILinkHandler
00050 #define NS_ILINKHANDLER_IID \
00051  { 0xa6cf905b, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
00052 
00053 enum nsLinkState {
00054   eLinkState_Unknown    = 0,
00055   eLinkState_Unvisited  = 1,
00056   eLinkState_Visited    = 2, 
00057   eLinkState_NotLink    = 3
00058 };
00059 
00060 // XXX Verb to use for link actuation. These are the verbs specified
00061 // in the current XLink draft. We may actually want to support more
00062 // (especially for extended links).
00063 enum nsLinkVerb {
00064   eLinkVerb_Replace = 0,
00065   eLinkVerb_New     = 1,
00066   eLinkVerb_Embed   = 2,
00067   eLinkVerb_Undefined = 3
00068 };
00069 
00073 class nsILinkHandler : public nsISupports {
00074 public:
00075   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ILINKHANDLER_IID)
00076 
00077   
00088   NS_IMETHOD OnLinkClick(nsIContent* aContent, 
00089                          nsLinkVerb aVerb,
00090                          nsIURI* aURI,
00091                          const PRUnichar* aTargetSpec,
00092                          nsIInputStream* aPostDataStream = 0,
00093                          nsIInputStream* aHeadersDataStream = 0) = 0;
00094 
00111   NS_IMETHOD OnLinkClickSync(nsIContent* aContent, 
00112                              nsLinkVerb aVerb,
00113                              nsIURI* aURI,
00114                              const PRUnichar* aTargetSpec,
00115                              nsIInputStream* aPostDataStream = 0,
00116                              nsIInputStream* aHeadersDataStream = 0,
00117                              nsIDocShell** aDocShell = 0,
00118                              nsIRequest** aRequest = 0) = 0;
00119 
00128   NS_IMETHOD OnOverLink(nsIContent* aContent, 
00129                         nsIURI* aURLSpec,
00130                         const PRUnichar* aTargetSpec) = 0;
00131 
00135   NS_IMETHOD OnLeaveLink() = 0;
00136       
00137 
00141   NS_IMETHOD GetLinkState(nsIURI* aLinkURI, nsLinkState& aState) = 0;
00142 };
00143 
00144 #endif /* nsILinkHandler_h___ */