Back to index

lightning-sunbird  0.9+nobinonly
nsIForm.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) 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 nsIForm_h___
00038 #define nsIForm_h___
00039 
00040 #include "nsISupports.h"
00041 #include "nsAString.h"
00042 
00043 class nsIFormControl;
00044 class nsIDOMHTMLInputElement;
00045 class nsIRadioVisitor;
00046 class nsISimpleEnumerator;
00047 class nsIURI;
00048 
00049 #define NS_FORM_METHOD_GET  0
00050 #define NS_FORM_METHOD_POST 1
00051 #define NS_FORM_ENCTYPE_URLENCODED 0
00052 #define NS_FORM_ENCTYPE_MULTIPART  1
00053 #define NS_FORM_ENCTYPE_TEXTPLAIN  2
00054 
00055 
00056 // IID for the nsIFormManager interface
00057 #define NS_IFORM_IID    \
00058 { 0xb7e94510, 0x4c19, 0x11d2,  \
00059   { 0x80, 0x3f, 0x0, 0x60, 0x8, 0x15, 0xa7, 0x91 } }
00060 
00061 
00068 class nsIForm : public nsISupports
00069 {
00070 public:
00071   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFORM_IID)
00072 
00073   
00079   NS_IMETHOD AddElement(nsIFormControl* aElement) = 0;
00080 
00089   NS_IMETHOD AddElementToTable(nsIFormControl* aElement,
00090                                const nsAString& aName) = 0;
00091 
00099   NS_IMETHOD GetElementAt(PRInt32 aIndex, nsIFormControl** aElement) const = 0;
00100 
00107   NS_IMETHOD GetElementCount(PRUint32* aCount) const = 0;
00108 
00115   NS_IMETHOD RemoveElement(nsIFormControl* aElement) = 0;
00116 
00128   NS_IMETHOD RemoveElementFromTable(nsIFormControl* aElement,
00129                                     const nsAString& aName) = 0;
00130 
00140   NS_IMETHOD ResolveName(const nsAString& aName,
00141                          nsISupports **aResult) = 0;
00142 
00148   NS_IMETHOD IndexOfControl(nsIFormControl* aControl, PRInt32* aIndex) = 0;
00149 
00155   NS_IMETHOD GetControlEnumerator(nsISimpleEnumerator** aEnum) = 0;
00156 
00162   NS_IMETHOD OnSubmitClickBegin() = 0;
00163   NS_IMETHOD OnSubmitClickEnd() = 0;
00164 
00171   NS_IMETHOD FlushPendingSubmission() = 0;
00178   NS_IMETHOD ForgetPendingSubmission() = 0;
00179 
00185   NS_IMETHOD GetActionURL(nsIURI** aActionURL) = 0;
00186 
00187 };
00188 
00189 #endif /* nsIForm_h___ */