parser/xml/public/nsISAXMutableAttributes.idl

Wed, 31 Dec 2014 13:27:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 13:27:57 +0100
branch
TOR_BUG_3246
changeset 6
8bccb770b82d
permissions
-rw-r--r--

Ignore runtime configuration files generated during quality assurance.

michael@0 1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0 2 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 3 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 5
michael@0 6 #include "nsISupports.idl"
michael@0 7 #include "nsISAXAttributes.idl"
michael@0 8
michael@0 9 /**
michael@0 10 * This interface extends the nsISAXAttributes interface with
michael@0 11 * manipulators so that the list can be modified or reused.
michael@0 12 */
michael@0 13 [scriptable, uuid(8b1de83d-cebb-49fa-8245-c0fe319eb7b6)]
michael@0 14 interface nsISAXMutableAttributes : nsISAXAttributes {
michael@0 15
michael@0 16 /**
michael@0 17 * Add an attribute to the end of the list.
michael@0 18 *
michael@0 19 * For the sake of speed, this method does no checking
michael@0 20 * to see if the attribute is already in the list: that is
michael@0 21 * the responsibility of the application.
michael@0 22 *
michael@0 23 * @param uri The Namespace URI, or the empty string if
michael@0 24 * none is available or Namespace processing is not
michael@0 25 * being performed.
michael@0 26 * @param localName The local name, or the empty string if
michael@0 27 * Namespace processing is not being performed.
michael@0 28 * @param qName The qualified (prefixed) name, or the empty string
michael@0 29 * if qualified names are not available.
michael@0 30 * @param type The attribute type as a string.
michael@0 31 * @param value The attribute value.
michael@0 32 */
michael@0 33 void addAttribute(in AString uri,
michael@0 34 in AString localName,
michael@0 35 in AString qName,
michael@0 36 in AString type,
michael@0 37 in AString value);
michael@0 38
michael@0 39 /**
michael@0 40 * Clear the attribute list for reuse.
michael@0 41 */
michael@0 42 void clear();
michael@0 43
michael@0 44 /**
michael@0 45 * Remove an attribute from the list.
michael@0 46 *
michael@0 47 * @param index The index of the attribute (zero-based).
michael@0 48 */
michael@0 49 void removeAttribute(in unsigned long index);
michael@0 50
michael@0 51 /**
michael@0 52 * Set the attributes list. This method will clear any attributes in
michael@0 53 * the list before adding the attributes from the argument.
michael@0 54 *
michael@0 55 * @param attributes The attributes object to replace populate the
michael@0 56 * list with.
michael@0 57 */
michael@0 58 void setAttributes(in nsISAXAttributes attributes);
michael@0 59
michael@0 60 /**
michael@0 61 * Set an attribute in the list.
michael@0 62 *
michael@0 63 * For the sake of speed, this method does no checking for name
michael@0 64 * conflicts or well-formedness: such checks are the responsibility
michael@0 65 * of the application.
michael@0 66 *
michael@0 67 * @param index The index of the attribute (zero-based).
michael@0 68 * @param uri The Namespace URI, or the empty string if
michael@0 69 * none is available or Namespace processing is not
michael@0 70 * being performed.
michael@0 71 * @param localName The local name, or the empty string if
michael@0 72 * Namespace processing is not being performed.
michael@0 73 * @param qName The qualified name, or the empty string
michael@0 74 * if qualified names are not available.
michael@0 75 * @param type The attribute type as a string.
michael@0 76 * @param value The attribute value.
michael@0 77 */
michael@0 78 void setAttribute(in unsigned long index,
michael@0 79 in AString uri,
michael@0 80 in AString localName,
michael@0 81 in AString qName,
michael@0 82 in AString type,
michael@0 83 in AString value);
michael@0 84
michael@0 85 /**
michael@0 86 * Set the local name of a specific attribute.
michael@0 87 *
michael@0 88 * @param index The index of the attribute (zero-based).
michael@0 89 * @param localName The attribute's local name, or the empty
michael@0 90 * string for none.
michael@0 91 */
michael@0 92 void setLocalName(in unsigned long index, in AString localName);
michael@0 93
michael@0 94 /**
michael@0 95 * Set the qualified name of a specific attribute.
michael@0 96 *
michael@0 97 * @param index The index of the attribute (zero-based).
michael@0 98 * @param qName The attribute's qualified name, or the empty
michael@0 99 * string for none.
michael@0 100 */
michael@0 101 void setQName(in unsigned long index, in AString qName);
michael@0 102
michael@0 103 /**
michael@0 104 * Set the type of a specific attribute.
michael@0 105 *
michael@0 106 * @param index The index of the attribute (zero-based).
michael@0 107 * @param type The attribute's type.
michael@0 108 */
michael@0 109 void setType(in unsigned long index, in AString type);
michael@0 110
michael@0 111 /**
michael@0 112 * Set the Namespace URI of a specific attribute.
michael@0 113 *
michael@0 114 * @param index The index of the attribute (zero-based).
michael@0 115 * @param uri The attribute's Namespace URI, or the empty
michael@0 116 * string for none.
michael@0 117 */
michael@0 118 void setURI(in unsigned long index, in AString uri);
michael@0 119
michael@0 120 /**
michael@0 121 * Set the value of a specific attribute.
michael@0 122 *
michael@0 123 * @param index The index of the attribute (zero-based).
michael@0 124 * @param value The attribute's value.
michael@0 125 */
michael@0 126 void setValue(in unsigned long index, in AString value);
michael@0 127 };

mercurial