Back to index

lightning-sunbird  0.9+nobinonly
nsXFormsDelegateStub.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  * Novell, Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2005
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Allan Beaufour <abeaufour@novell.com>
00024  *  Olli Pettay <Olli.Pettay@helsinki.fi>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * 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 __NSXFORMSDELEGATESTUB_H__
00041 #define __NSXFORMSDELEGATESTUB_H__
00042 
00043 #include "nsAutoPtr.h"
00044 #include "nsCOMPtr.h"
00045 #include "nsString.h"
00046 #include "nsIDOMElement.h"
00047 #include "nsIDelegateInternal.h"
00048 #include "nsXFormsControlStub.h"
00049 #include "nsIXFormsUIWidget.h"
00050 #include "nsXFormsAccessors.h"
00051 
00052 class nsIAtom;
00053 
00054 enum nsRestrictionFlag {
00055   eTypes_NoRestriction,
00056   eTypes_Inclusive,
00057   eTypes_Exclusive
00058 };
00059 
00063 class nsXFormsDelegateStub : public nsXFormsBindableControlStub,
00064                              public nsIDelegateInternal
00065 {
00066 public:
00067   NS_DECL_ISUPPORTS_INHERITED
00068   NS_DECL_NSIXFORMSDELEGATE
00069   NS_DECL_NSIDELEGATEINTERNAL
00070 
00071   NS_IMETHOD OnCreated(nsIXTFBindableElementWrapper *aWrapper);
00072   NS_IMETHOD OnDestroyed();
00073 
00074   // nsIXFormsControl
00075   NS_IMETHOD TryFocus(PRBool* aOK);
00076   NS_IMETHOD Refresh();
00077 
00094   NS_IMETHOD IsTypeAllowed(PRUint16 aType, PRBool *aIsAllowed,
00095                            nsRestrictionFlag *aRestriction,
00096                            nsAString &aTypes);
00097 
00098 #ifdef DEBUG_smaug
00099   virtual const char* Name()
00100   {
00101     if (mControlType.IsEmpty()) {
00102       return "[undefined delegate]";
00103     }
00104 
00105     return NS_ConvertUTF16toUTF8(mControlType).get();
00106   }
00107 #endif
00108 
00109 
00110   nsXFormsDelegateStub(const nsAString& aType = EmptyString())
00111     : mControlType(aType) {}
00112 
00113 protected:
00114   // Sets/removes the moz:type attribute. The attribute can be used to detect the
00115   // type of the node, which is bound the the control.
00116   void SetMozTypeAttribute();
00117 
00118   nsString      mControlType;
00120   nsRefPtr<nsXFormsAccessors> mAccessor;
00121 };
00122 
00123 #endif