1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 the Mozilla XTF project.
16 *
17 * The Initial Developer of the Original Code is
18 * Alex Fritze.
19 * Portions created by the Initial Developer are Copyright (C) 2004
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Alex Fritze <alex@croczilla.com> (original author)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40 interface nsIAtom;
41
42 [scriptable, uuid(72152f7f-7e8d-43fd-8477-3f29ae8d240d)]
43 interface nsIXTFAttributeHandler : nsISupports
44 {
45 // If 'false' the given attribute will be handled by the wrapper.
46 // Namespaced attributes will always be handled by the wrapper. The
47 // set of attributes handled by the attribute handler should remain
48 // constant for its complete lifetime.
49 boolean handlesAttribute(in nsIAtom name);
50
51 void setAttribute(in nsIAtom name, in AString newValue);
52
53 void removeAttribute(in nsIAtom name);
54
55 // If the attribute 'name' is unknown the implementation should mark
56 // the returned string as being 'null' (i.e. return 'null' in JS;
57 // call SetIsVoid(PR_TRUE) in C++) rather than throw an exception.
58 // A 'void' result will be translated into the attribute missing
59 // by the wrapper. An empty result will be translated into
60 // the attribute having no value.
61 AString getAttribute(in nsIAtom name);
62
63 boolean hasAttribute(in nsIAtom name);
64
65 unsigned long getAttributeCount();
66
67 // note that this method should return an *atom* not a string.
68 nsIAtom getAttributeNameAt(in unsigned long index);
69 };