Back to index

lightning-sunbird  0.9+nobinonly
nsXFormsActionModuleBase.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 XForms support.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Olli Pettay.
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Olli Pettay <Olli.Pettay@helsinki.fi> (original author)
00024  *   John L. Clark <jlc6@po.cwru.edu>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef nsXFormsActionModuleBase_h_
00041 #define nsXFormsActionModuleBase_h_
00042 
00043 #include "nsIDOMEventListener.h"
00044 #include "nsIXFormsActionElement.h"
00045 #include "nsXFormsStubElement.h"
00046 #include "nsIDOMElement.h"
00047 #include "nsIXFormsActionModuleElement.h"
00048 #include "nsCOMPtr.h"
00049 #include "nsXFormsUtils.h"
00050 
00051 class nsXFormsActionModuleHelper
00052 {
00062 public:
00063   nsXFormsActionModuleHelper() : mCanIterate(PR_TRUE) {}
00064   virtual nsIDOMElement* GetElement() = 0;
00065   PRBool CanIterate() { return mCanIterate; }
00066   void SetCurrentEvent(nsIDOMEvent* aEvent) { mCurrentEvent = aEvent; }
00074   virtual nsresult
00075     HandleSingleAction(nsIDOMEvent *aEvent,
00076                        nsIXFormsActionElement *aParentAction) = 0;
00077 protected:
00085   PRBool mCanIterate;
00086 
00090   nsCOMPtr<nsIDOMEvent> mCurrentEvent;
00091 };
00092 
00093 class nsXFormsActionModuleBase : public nsIDOMEventListener,
00094                                  public nsXFormsStubElement,
00095                                  public nsIXFormsActionModuleElement,
00096                                  public nsXFormsActionModuleHelper
00097 {
00098 public:
00099   nsXFormsActionModuleBase();
00100   virtual ~nsXFormsActionModuleBase();
00101   NS_DECL_ISUPPORTS_INHERITED
00102   NS_DECL_NSIXFORMSACTIONMODULEELEMENT
00103   NS_DECL_NSIXTFGENERICELEMENT
00104   NS_DECL_NSIDOMEVENTLISTENER
00105   NS_IMETHOD OnDestroyed();
00106   NS_IMETHOD WillChangeDocument(nsIDOMDocument *aNewDocument);
00107   NS_IMETHOD DocumentChanged(nsIDOMDocument *aNewDocument);
00108   NS_IMETHOD WillChangeParent(nsIDOMElement *aNewParent);
00109   NS_IMETHOD ParentChanged(nsIDOMElement *aNewParent);
00110 
00111   virtual nsIDOMElement *GetElement() { return mElement; }
00112 
00113   static nsresult DoHandleAction(nsXFormsActionModuleHelper *aXFormsAction,
00114                                  nsIDOMEvent                *aEvent,
00115                                  nsIXFormsActionElement     *aParentAction);
00126   static PRBool CanPerformAction(nsIDOMElement  *aElement,
00127                                  PRBool         *aUsesWhile,
00128                                  nsIDOMNode     *aContextNode = nsnull,
00129                                  PRInt32         aContextSize = 0,
00130                                  PRInt32         aContextPosition = 0);
00131 protected:
00132   nsIDOMElement *mElement;
00133 };
00134 
00135 #endif
00136