/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1999 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ /** * MODULE NOTES: * @created kmcclusk 10/19/99 * */ #ifndef nsIFormProcessor_h__ #define nsIFormProcessor_h__ #include "nsISupports.h" #include "prtypes.h" #include "nsIDOMHTMLInputElement.h" class nsString; class nsVoidArray; // {0ae53c0f-8ea2-4916-bedc-717443c3e185} #define NS_FORMPROCESSOR_CID \ { 0x0ae53c0f, 0x8ea2, 0x4916, { 0xbe, 0xdc, 0x71, 0x74, 0x43, 0xc3, 0xe1, 0x85 } } #define NS_FORMPROCESSOR_CONTRACTID "@mozilla.org/layout/form-processor;1" // 4ff86376-6982-4f64-a683-a6ae4984afd7 #define NS_IFORMPROCESSOR_IID \ { 0x4ff86376, 0x6982, 0x4f64, { 0xa6, 0x83, 0xa6, 0xae, 0x49, 0x84, 0xaf, 0xd7 } } // XXX:In the future, we should examine combining this interface with nsIFormSubmitObserver. // nsIFormSubmitObserver could have a before, during, and after form submission methods. // The before and after methods would be passed a nsISupports interface. The During would // Have the same method signature as ProcessValue. class nsIFormProcessor : public nsISupports { public: NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFORMPROCESSOR_IID) /* ProcessValue is called for each name value pair that is * about to be submitted for both "get" and "post" form submissions. * * The formprocessor is registered as a service that gets called for * every form submission. * * @param aElement element which the attribute/value pair is submitted for * @param aName value of the form element name attribute about to be submitted * @param aValue On entry it contains the value about to be submitted for aName. * On exit it contains the value which will actually be submitted for aName. * */ NS_IMETHOD ProcessValue(nsIDOMHTMLElement *aElement, const nsAString& aName, nsAString& aValue) = 0; /* Provide content for a form element. This method provides a mechanism to provide * content which comes from a source other than the document (i.e. a local database) * * @param aFormType Type of form to get content for. * @param aOptions List of nsStrings which define the contents for the form element * @param aAttr Attribute to be attached to the form element. It is used to identify * the form element contains non-standard content. */ NS_IMETHOD ProvideContent(const nsAString& aFormType, nsVoidArray& aContent, nsAString& aAttribute) = 0; }; #endif /* nsIFormProcessor_h__ */