content/base/public/nsIXFormsUtilityService.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla XForms support.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * IBM Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Aaron Reed <aaronr@us.ibm.com>
  24  *  Alexander Surkov <surkov.alexander@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsIXFormsUtilityService_h
  41 #define nsIXFormsUtilityService_h
  42
  43 #include "nsISupports.h"
  44
  45 class nsIDOMNode;
  46 class nsIDOMNodeList;
  47 class nsIEditor;
  48
  49 /* For IDL files that don't want to include root IDL files. */
  50 #ifndef NS_NO_VTABLE
  51 #define NS_NO_VTABLE
  52 #endif
  53
  54 /* nsIXFormsUtilityService */
  55 #define NS_IXFORMSUTILITYSERVICE_IID_STR "cd3457b6-cb6a-496c-bdfa-6cfecb2bd5fb"
  56 #define NS_IXFORMSUTILITYSERVICE_IID \
  57 { 0xcd3457b6, 0xcb6a, 0x496c, \
  58   { 0xbd, 0xfa, 0x6c, 0xfe, 0xcb, 0x2b, 0xd5, 0xfb } }
  59
  60
  61 /**
  62  * Private interface implemented by the nsXFormsUtilityService in XForms
  63  * extension.
  64  */
  65 class NS_NO_VTABLE nsIXFormsUtilityService : public nsISupports {
  66 public:
  67
  68   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IXFORMSUTILITYSERVICE_IID)
  69
  70   enum {
  71     STATE_OUT_OF_RANGE,
  72     STATE_IN_RANGE,
  73     STATE_NOT_A_RANGE
  74   };
  75
  76   /**
  77    * Returns the name of the builtin type of the instance node that aElement is
  78    * bound to. Fails if aElement doesn't have a bound node.
  79    */
  80   NS_IMETHOD GetBuiltinTypeName(nsIDOMNode *aElement, nsAString& aName) = 0;
  81
  82   /**
  83    * Return true if instance node that element is bound to is readonly.
  84    */
  85   NS_IMETHOD IsReadonly(nsIDOMNode *aElement, PRBool *aState) = 0;
  86
  87   /**
  88    * Return true if instance node that element is bound to is relevant.
  89    */
  90   NS_IMETHOD IsRelevant(nsIDOMNode *aElement, PRBool *aState) = 0;
  91
  92   /**
  93    * Return true if instance node that element is bound to is required.
  94    */
  95   NS_IMETHOD IsRequired(nsIDOMNode *aElement, PRBool *aState) = 0;
  96
  97   /**
  98    * Return true if instance node that element is bound to is valid.
  99    */
 100   NS_IMETHOD IsValid(nsIDOMNode *aElement, PRBool *aState) = 0;
 101
 102   /**
 103    * Return constant declared above that indicates whether instance node that
 104    * element is bound to is out of range, is in range or neither. The last value
 105    * is used if element can't have in-range or out-of-range state, for exmple,
 106    * xforms:input.
 107    */
 108   NS_IMETHOD IsInRange(nsIDOMNode *aElement, PRUint32 *aState) = 0;
 109
 110   /**
 111    * Return value of instance node that given node is bound to. If given node is
 112    * xforms:item element then the method returns item value.
 113    */
 114   NS_IMETHOD GetValue(nsIDOMNode *aElement, nsAString& aValue) = 0;
 115
 116   /**
 117    * Set the focus to xforms element.
 118    */
 119   NS_IMETHOD Focus(nsIDOMNode *aElement) = 0;
 120
 121   /**
 122    * Return @start attribute value of xforms:range element. Failure if
 123    * given element is not xforms:range.
 124    */
 125   NS_IMETHOD GetRangeStart(nsIDOMNode *aElement, nsAString& aValue) = 0;
 126
 127   /**
 128    * Return @end attribute value of xforms:range element. Failure if
 129    * given element is not xforms:range.
 130    */
 131   NS_IMETHOD GetRangeEnd(nsIDOMNode *aElement, nsAString& aValue) = 0;
 132
 133   /**
 134    * Return @step attribute value of xforms:range element. Failure if
 135    * given element is not xforms:range.
 136    */
 137   NS_IMETHOD GetRangeStep(nsIDOMNode *aElement, nsAString& aValue) = 0;
 138
 139   /**
 140    * Return nsIEditor for xforms element if element is editable, null if it is
 141    * not editable. Failure if given element doesn't support editing.
 142    */
 143   NS_IMETHOD GetEditor(nsIDOMNode *aElement, nsIEditor **aEditor) = 0;
 144
 145   /**
 146    * Return true if dropmarker is in open state (combobox popup is open),
 147    * otherwise false. Failure if given 'aElement' node is not direct child of
 148    * combobox element or is not combobox itself.
 149    */
 150   NS_IMETHOD IsDropmarkerOpen(nsIDOMNode *aElement, PRBool* aIsOpen) = 0;
 151
 152   /**
 153    * Toggles dropmarker state (close/open combobox popup). Failure if given
 154    * 'aElement' node is not direct child of combobox element or is not combobox
 155    * itself.
 156    */
 157   NS_IMETHOD ToggleDropmarkerState(nsIDOMNode *aElement) = 0;
 158
 159   /**
 160    * Get selected xforms:item element for xforms:select1. Failure if
 161    * given 'aElement' node is not xforms:select1.
 162    */
 163   NS_IMETHOD GetSelectedItemForSelect1(nsIDOMNode *aElement,
 164                                        nsIDOMNode ** aItem) = 0;
 165
 166   /**
 167    * Set selected xforms:item element for xforms:select1. Failure if
 168    * given 'aElement' node is not xforms:select1.
 169    */
 170   NS_IMETHOD SetSelectedItemForSelect1(nsIDOMNode *aElement,
 171                                        nsIDOMNode *aItem) = 0;
 172
 173   /**
 174    * Get the list of selected xforms:item elements from the xforms:select.
 175    * Failure if given 'aElement' node is not xforms:select.
 176    */
 177   NS_IMETHOD GetSelectedItemsForSelect(nsIDOMNode *aElement,
 178                                        nsIDOMNodeList **aItems) = 0;
 179
 180   /**
 181    * Add xforms:item element to selection of xforms:select. Failure if
 182    * given 'aElement' node is not xforms:select.
 183    */
 184   NS_IMETHOD AddItemToSelectionForSelect(nsIDOMNode *aElement,
 185                                          nsIDOMNode *Item) = 0;
 186
 187   /**
 188    * Remove xforms:item element from selection of xforms:select. Failure if
 189    * given 'aElement' node is not xforms:select.
 190    */
 191   NS_IMETHOD RemoveItemFromSelectionForSelect(nsIDOMNode *aElement,
 192                                               nsIDOMNode *Item) = 0;
 193
 194   /**
 195    * Deslect all xforms:item elements contained in the given xforms:select.
 196    * Failure if given 'aElement' node is not xforms:select.
 197    */
 198   NS_IMETHOD ClearSelectionForSelect(nsIDOMNode *aElement) = 0;
 199
 200   /**
 201    * Select all xforms:item elements of xforms:select. Failure if
 202    * given 'aElement' node is not xforms:select.
 203    */
 204   NS_IMETHOD SelectAllItemsForSelect(nsIDOMNode *aElement) = 0;
 205
 206   /**
 207    * Return true if given xforms:item element of xforms:select is selected,
 208    * otherwise return false. Failure if given 'aElement' node is not
 209    * xforms:select.
 210    */
 211   NS_IMETHOD IsSelectItemSelected(nsIDOMNode *aElement, nsIDOMNode *aItem,
 212                                   PRBool *aIsSelected) = 0;
 213
 214   /**
 215    * Return the list of xforms:item or xforms:choices elements that are children
 216    * of the given 'aElement' node. 'aElement' node may be a xforms:select,
 217    * xforms:select1, xforms:choices or xforms:itemset element. Otherwise
 218    * failure.
 219    */
 220   NS_IMETHOD GetSelectChildrenFor(nsIDOMNode *aElement,
 221                                   nsIDOMNodeList **aNodeList) = 0;
 222 };
 223
 224 NS_DEFINE_STATIC_IID_ACCESSOR(nsIXFormsUtilityService,
 225                               NS_IXFORMSUTILITYSERVICE_IID)
 226
 227 #endif /* nsIXFormsUtilityService_h */