RetroZilla/extensions/xforms/nsXFormsDelegateStub.h

124 lines
4.3 KiB
C
Raw Normal View History

2015-10-21 05:03:22 +02:00
/* -*- 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 XForms support.
*
* The Initial Developer of the Original Code is
* Novell, Inc.
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Allan Beaufour <abeaufour@novell.com>
* Olli Pettay <Olli.Pettay@helsinki.fi>
*
* Alternatively, the contents of this file may be used under the terms of
* either 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 ***** */
#ifndef __NSXFORMSDELEGATESTUB_H__
#define __NSXFORMSDELEGATESTUB_H__
#include "nsAutoPtr.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsIDOMElement.h"
#include "nsIDelegateInternal.h"
#include "nsXFormsControlStub.h"
#include "nsIXFormsUIWidget.h"
#include "nsXFormsAccessors.h"
class nsIAtom;
enum nsRestrictionFlag {
eTypes_NoRestriction,
eTypes_Inclusive,
eTypes_Exclusive
};
/**
* Stub implementation of the nsIXFormsDelegate interface.
*/
class nsXFormsDelegateStub : public nsXFormsBindableControlStub,
public nsIDelegateInternal
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIXFORMSDELEGATE
NS_DECL_NSIDELEGATEINTERNAL
NS_IMETHOD OnCreated(nsIXTFBindableElementWrapper *aWrapper);
NS_IMETHOD OnDestroyed();
// nsIXFormsControl
NS_IMETHOD TryFocus(PRBool* aOK);
NS_IMETHOD Refresh();
/**
* This function is overridden by controls that are restricted in the
* datatypes that they can bind to. aTypes will be filled out and returned
* only if aIsAllowed is found to be PR_FALSE.
*
* @param aType Type we are testing against
* @param aIsAllowed Indicates whether control can bind to aType
* @param aRestriction Output. If eTypes_Inclusive, then the types returned
* in aTypes is the list of builtin types that this
* control can bind to. If eTypes_Exclusive, the types
* returned in aTypes is the list of builtin types that
* this control cannot be bound to.
* @param aTypes Output. A " " delimited list of builtin types that
* the control has some restriction with, as specified
* by aRestriction.
*/
NS_IMETHOD IsTypeAllowed(PRUint16 aType, PRBool *aIsAllowed,
nsRestrictionFlag *aRestriction,
nsAString &aTypes);
#ifdef DEBUG_smaug
virtual const char* Name()
{
if (mControlType.IsEmpty()) {
return "[undefined delegate]";
}
return NS_ConvertUTF16toUTF8(mControlType).get();
}
#endif
nsXFormsDelegateStub(const nsAString& aType = EmptyString())
: mControlType(aType) {}
protected:
// Sets/removes the moz:type attribute. The attribute can be used to detect the
// type of the node, which is bound the the control.
void SetMozTypeAttribute();
nsString mControlType;
/** The accessors object for this delegate */
nsRefPtr<nsXFormsAccessors> mAccessor;
};
#endif