/usr/share/idl/firefox/nsISAXAttributes.idl is in firefox-dev 11.0+build1-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | /* -*- 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.org code.
*
* The Initial Developer of the Original Code is Robert Sayre.
*
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* 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 ***** */
#include "nsISupports.idl"
/**
* Interface for a list of XML attributes.
*
* This interface allows access to a list of attributes in
* three different ways:
*
* 1.) by attribute index;
* 2.) by Namespace-qualified name; or
* 3.) by XML qualified name.
*
* The list will not contain attributes that were declared #IMPLIED
* but not specified in the start tag. It will also not contain
* attributes used as Namespace declarations (xmlns*) unless the
* http://xml.org/sax/features/namespace-prefixes feature
* is set to true (it is false by default).
*
* The order of attributes in the list is unspecified.
*/
[scriptable, uuid(e347005e-6cd0-11da-be43-001422106990)]
interface nsISAXAttributes : nsISupports
{
/**
* Look up the index of an attribute by Namespace name.
* @param uri The Namespace URI, or the empty string
* if the name has no Namespace URI.
* @param localName The attribute's local name.
* @return The index of the attribute, or -1
* if it does not appear in the list.
*/
long getIndexFromName(in AString uri, in AString localName);
/**
* Look up the index of an attribute by XML qualified name.
* @param qName The qualified name.
* @return The index of the attribute, or -1
* if it does not appear in the list.
*/
long getIndexFromQName(in AString qName);
/**
* Return the number of attributes in the list. Once you know the
* number of attributes, you can iterate through the list.
*
* @return The number of attributes in the list.
*/
readonly attribute long length;
/**
* Look up an attribute's local name by index.
* @param index The attribute index (zero-based).
* @return The local name, or null if the index is out of range.
*/
AString getLocalName(in unsigned long index);
/**
* Look up an attribute's XML qualified name by index.
* @param index The attribute index (zero-based).
* @return The XML qualified name, or the empty string if none is
* available, or null if the index is out of range.
*/
AString getQName(in unsigned long index);
/**
* Look up an attribute's type by index. The attribute type is one
* of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN",
* "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper
* case). If the parser has not read a declaration for the
* attribute, or if the parser does not report attribute types, then
* it must return the value "CDATA" as stated in the XML 1.0
* Recommendation (clause 3.3.3, "Attribute-Value
* Normalization"). For an enumerated attribute that is not a
* notation, the parser will report the type as "NMTOKEN".
*
* @param index The attribute index (zero-based).
* @return The attribute's type as a string, or null if the index is
* out of range.
*/
AString getType(in unsigned long index);
/**
* Look up an attribute's type by Namespace name.
* @param uri The Namespace URI, or the empty string
* if the name has no Namespace URI.
* @param localName The attribute's local name.
* @return The attribute type as a string, or null if the attribute
* is not in the list.
*/
AString getTypeFromName(in AString uri, in AString localName);
/**
* Look up an attribute's type by XML qualified name.
* @param qName The qualified name.
* @return The attribute type as a string, or null if the attribute
* is not in the list.
*/
AString getTypeFromQName(in AString qName);
/**
* Look up an attribute's Namespace URI by index.
* @param index The attribute index (zero-based).
* @return The Namespace URI, or the empty string if none is available,
* or null if the index is out of range.
*/
AString getURI(in unsigned long index);
/**
* Look up an attribute's value by index. If the attribute value is
* a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will
* be concatenated into a single string with each token separated by
* a single space.
*
* @param index The attribute index (zero-based).
* @return The attribute's value as a string, or null if the index is
* out of range.
*/
AString getValue(in unsigned long index);
/**
* Look up an attribute's value by Namespace name. If the attribute
* value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the
* tokens will be concatenated into a single string with each token
* separated by a single space.
*
* @param uri The Namespace URI, or the empty string
* if the name has no Namespace URI.
* @param localName The attribute's local name.
* @return The attribute's value as a string, or null if the attribute is
* not in the list.
*/
AString getValueFromName(in AString uri, in AString localName);
/**
* Look up an attribute's value by XML qualified (prefixed) name.
* If the attribute value is a list of tokens (IDREFS, ENTITIES, or
* NMTOKENS), the tokens will be concatenated into a single string
* with each token separated by a single space.
*
* @param qName The qualified (prefixed) name.
* @return The attribute's value as a string, or null if the attribute is
* not in the list.
*/
AString getValueFromQName(in AString qName);
};
|