2004-10-26 04:34:03 +04:00
|
|
|
/* -*- Mode: IDL; 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
|
|
|
|
* IBM Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2004
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Brian Ryner <bryner@brianryner.com>
|
|
|
|
*
|
|
|
|
* 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 ***** */
|
|
|
|
|
2005-02-09 12:57:31 +03:00
|
|
|
#include "nsIXFormsContextControl.idl"
|
2004-11-05 00:12:22 +03:00
|
|
|
|
2005-01-19 19:05:31 +03:00
|
|
|
interface nsIDOMNode;
|
|
|
|
interface nsIDOMElement;
|
2005-02-24 17:35:27 +03:00
|
|
|
%{C++
|
|
|
|
#include "nsCOMArray.h"
|
|
|
|
%}
|
|
|
|
|
|
|
|
[ptr] native nsCOMArrayPtr(nsCOMArray<nsIDOMNode>);
|
2005-01-19 19:05:31 +03:00
|
|
|
|
2004-10-26 04:34:03 +04:00
|
|
|
/**
|
|
|
|
* Interface implemented by all XForms form control classes.
|
|
|
|
*/
|
2006-05-22 13:06:14 +04:00
|
|
|
[uuid(8c84afe1-e071-4d45-b3da-c5aa93154343)]
|
2005-02-09 12:57:31 +03:00
|
|
|
interface nsIXFormsControl : nsIXFormsContextControl
|
2004-10-26 04:34:03 +04:00
|
|
|
{
|
2005-01-27 22:30:03 +03:00
|
|
|
/**
|
|
|
|
* Tries to move focus to form control and returns true if succeeded.
|
|
|
|
*/
|
|
|
|
boolean tryFocus();
|
|
|
|
|
2005-01-19 19:05:31 +03:00
|
|
|
/**
|
|
|
|
* The instance node that the control is bound to.
|
|
|
|
*/
|
|
|
|
readonly attribute nsIDOMNode boundNode;
|
|
|
|
|
2006-05-22 13:06:14 +04:00
|
|
|
/**
|
|
|
|
* Binds the control to the model. Only handles attaching to the model
|
|
|
|
* (including reattaching from any old model).
|
|
|
|
*
|
|
|
|
* @note It can also set the boundNode, but does not do a proper node
|
|
|
|
* binding, as in setting up dependencies, attaching index() listeners, etc.
|
|
|
|
*
|
|
|
|
* @param setBoundNode Set boundNode too?
|
|
|
|
*/
|
|
|
|
void bindToModel(in boolean setBoundNode);
|
|
|
|
|
2005-01-19 19:05:31 +03:00
|
|
|
/**
|
|
|
|
* The instance nodes that the control depend on.
|
|
|
|
*
|
|
|
|
* In other words, all the instance nodes that could influence which node
|
|
|
|
* the control is bound to (mBoundNode). For example:
|
|
|
|
* If a node has @ref="/share[@owner = /me]", it depends on all /share
|
2006-05-22 13:06:14 +04:00
|
|
|
* nodes, all @owner attributes on /share nodes, and all /me nodes.
|
2005-01-19 19:05:31 +03:00
|
|
|
*/
|
2005-02-24 17:35:27 +03:00
|
|
|
readonly attribute nsCOMArrayPtr dependencies;
|
2005-01-19 19:05:31 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the element that should receive events for the control.
|
|
|
|
*
|
|
|
|
* @todo This should not be necessary, we should send directly to the
|
|
|
|
* control (XXX)
|
|
|
|
*/
|
|
|
|
readonly attribute nsIDOMElement element;
|
2005-05-17 16:10:08 +04:00
|
|
|
|
|
|
|
/** According to sec 4.1 in the spec, only certain controls are allowed to
|
|
|
|
* be targets of the interaction and notification events. The controls
|
|
|
|
* that inherit from nsXFormsControlStub that SHOULDN'T get these events
|
|
|
|
* need to override IsEventTarget() and return PR_FALSE
|
|
|
|
*/
|
|
|
|
boolean isEventTarget();
|
2006-02-23 14:25:07 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Is true when the control is getting its instance data node binding from a
|
|
|
|
* model bind element, ie. it has a |bind| attribute.
|
|
|
|
*/
|
|
|
|
readonly attribute boolean usesModelBinding;
|
2006-05-24 07:45:45 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* These represent the default intrinsic states for controls when they are
|
|
|
|
* enabled and disabled.
|
|
|
|
*/
|
|
|
|
readonly attribute long defaultIntrinsicState;
|
|
|
|
readonly attribute long disabledIntrinsicState;
|
2004-10-26 04:34:03 +04:00
|
|
|
};
|