Back to index

lightning-sunbird  0.9+nobinonly
nsIFormSubmission.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 nsIFormSubmission_h___
00038 #define nsIFormSubmission_h___
00039 
00040 #include "nsISupports.h"
00041 class nsAString;
00042 class nsACString;
00043 class nsIURI;
00044 class nsIInputStream;
00045 class nsGenericHTMLElement;
00046 class nsPresContext;
00047 class nsIContent;
00048 class nsIFormControl;
00049 class nsIDOMHTMLElement;
00050 class nsIDocShell;
00051 class nsIRequest;
00052 
00053 #define NS_IFORMSUBMISSION_IID   \
00054 { 0x7ee38e3a, 0x1dd2, 0x11b2, \
00055   {0x89, 0x6f, 0xab, 0x28, 0x03, 0x96, 0x25, 0xa9} }
00056 
00061 class nsIFormSubmission : public nsISupports
00062 {
00063 public:
00064 
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFORMSUBMISSION_IID)
00066 
00067   
00072   virtual PRBool AcceptsFiles() const = 0;
00073 
00085   virtual nsresult SubmitTo(nsIURI* aActionURL, const nsAString& aTarget,
00086                             nsIContent* aSource, nsPresContext* aPresContext,
00087                             nsIDocShell** aDocShell,
00088                             nsIRequest** aRequest) = 0;
00089 
00097   virtual nsresult AddNameValuePair(nsIDOMHTMLElement* aSource,
00098                                     const nsAString& aName,
00099                                     const nsAString& aValue) = 0;
00100 
00112   virtual nsresult AddNameFilePair(nsIDOMHTMLElement* aSource,
00113                                const nsAString& aName,
00114                                const nsAString& aFilename,
00115                                nsIInputStream* aStream,
00116                                const nsACString& aContentType,
00117                                PRBool aMoreFilesToCome) = 0;
00118 
00119 };
00120 
00121 //
00122 // Factory methods
00123 // 
00124 
00132 nsresult GetSubmissionFromForm(nsGenericHTMLElement* aForm,
00133                                nsPresContext* aPresContext,
00134                                nsIFormSubmission** aFormSubmission);
00135 
00136 
00137 #endif /* nsIFormSubmission_h___ */