Back to index

lightning-sunbird  0.9+nobinonly
nsIFormSubmitObserver.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.org 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) 1999
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 
00038 
00045 #ifndef nsIFormSubmitObserver_h__
00046 #define nsIFormSubmitObserver_h__
00047 
00048 #include "nsISupports.h"
00049 #include "prtypes.h"
00050 
00051 class nsIContent;
00052 class nsIDOMWindowInternal;
00053 class nsIURI;
00054 
00055 // {a6cf9106-15b3-11d2-932e-00805f8add32}
00056 #define NS_IFORMSUBMITOBSERVER_IID      \
00057 { 0xa6cf9106, 0x15b3, 0x11d2, {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
00058 
00059 #define NS_FORMSUBMIT_SUBJECT "formsubmit"
00060 // used when actionURL is not needed and accuracy of form data is more important
00061 #define NS_EARLYFORMSUBMIT_SUBJECT "earlyformsubmit"
00062 #define NS_FIRST_FORMSUBMIT_CATEGORY "firstformsubmit"
00063 #define NS_PASSWORDMANAGER_CATEGORY "passwordmanager"
00064 
00065 class nsIFormSubmitObserver : public nsISupports {
00066 public:
00067   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFORMSUBMITOBSERVER_IID)
00068 
00069   /*
00070    *   Subject calls the observer when the form is submitted
00071    *   @param formNode- the dom node corresonding to this form.
00072    *   @param window- the window that the form submit occured in.
00073    *                  NOTE: This is not necessarily the same window the form submit result
00074    *                        will be loaded in (form could have target attribute set)
00075    *   @param actionURL- URL to which the form will be submitted.
00076    *   @param cancelSubmit- outparam - cancels form submit if set to true
00077    */
00078   NS_IMETHOD Notify(nsIContent* formNode, nsIDOMWindowInternal* window, nsIURI* actionURL, PRBool* cancelSubmit) = 0;
00079 
00080 };
00081 
00082 #endif /* nsIFormSubmitObserver_h__ */
00083