Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIFormSubmission Class Reference

Interface for form submissions; encompasses the function to call to submit as well as the form submission name/value pairs. More...

#include <nsIFormSubmission.h>

Inheritance diagram for nsIFormSubmission:
Inheritance graph
[legend]
Collaboration diagram for nsIFormSubmission:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual PRBool AcceptsFiles () const =0
 Find out whether or not this form submission accepts files.
virtual nsresult SubmitTo (nsIURI *aActionURL, const nsAString &aTarget, nsIContent *aSource, nsPresContext *aPresContext, nsIDocShell **aDocShell, nsIRequest **aRequest)=0
 Call to perform the submission.
virtual nsresult AddNameValuePair (nsIDOMHTMLElement *aSource, const nsAString &aName, const nsAString &aValue)=0
 Submit a name/value pair.
virtual nsresult AddNameFilePair (nsIDOMHTMLElement *aSource, const nsAString &aName, const nsAString &aFilename, nsIInputStream *aStream, const nsACString &aContentType, PRBool aMoreFilesToCome)=0
 Submit a name/file pair.

Detailed Description

Interface for form submissions; encompasses the function to call to submit as well as the form submission name/value pairs.

Definition at line 61 of file nsIFormSubmission.h.


Member Function Documentation

virtual PRBool nsIFormSubmission::AcceptsFiles ( ) const [pure virtual]

Find out whether or not this form submission accepts files.

Parameters:
aAcceptsFilesthe boolean output

Implemented in nsFSTextPlain, nsFSMultipartFormData, and nsFSURLEncoded.

Here is the caller graph for this function:

virtual nsresult nsIFormSubmission::AddNameFilePair ( nsIDOMHTMLElement aSource,
const nsAString &  aName,
const nsAString &  aFilename,
nsIInputStream aStream,
const nsACString &  aContentType,
PRBool  aMoreFilesToCome 
) [pure virtual]

Submit a name/file pair.

Parameters:
aSourcethe control sending the parameter
aNamethe name of the parameter
aFilenamethe name of the file (pass null to provide no name)
aStreamthe stream containing the file data to be sent
aContentTypethe content-type of the file data being sent
aMoreFilesToCometrue if another name/file pair with the same name will be sent soon

Implemented in nsFSTextPlain, nsFSMultipartFormData, and nsFSURLEncoded.

Here is the caller graph for this function:

virtual nsresult nsIFormSubmission::AddNameValuePair ( nsIDOMHTMLElement aSource,
const nsAString &  aName,
const nsAString &  aValue 
) [pure virtual]

Submit a name/value pair.

Parameters:
aSourcethe control sending the parameter
aNamethe name of the parameter
aValuethe value of the parameter

Implemented in nsFSTextPlain, nsFSMultipartFormData, and nsFSURLEncoded.

Here is the caller graph for this function:

virtual nsresult nsIFormSubmission::SubmitTo ( nsIURI aActionURL,
const nsAString &  aTarget,
nsIContent aSource,
nsPresContext aPresContext,
nsIDocShell **  aDocShell,
nsIRequest **  aRequest 
) [pure virtual]

Call to perform the submission.

Parameters:
aActionURLthe URL to submit to (may be modified with GET contents)
aTargetthe target window
aSourcethe element responsible for the submission (for web shell)
aPresContextthe presentation context
aDocShell(out param) the DocShell in which the submission was loaded
aRequest(out param) the Request for the submission

Implemented in nsFormSubmission.

Here is the caller graph for this function:


The documentation for this class was generated from the following file: