Back to index

lightning-sunbird  0.9+nobinonly
nsIXTFAttributeHandler.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Mozilla XTF project.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Alex Fritze.
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alex Fritze <alex@croczilla.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 interface nsIAtom;
00041 
00042 [scriptable, uuid(72152f7f-7e8d-43fd-8477-3f29ae8d240d)]
00043 interface nsIXTFAttributeHandler : nsISupports
00044 {
00045   // If 'false' the given attribute will be handled by the wrapper.
00046   // Namespaced attributes will always be handled by the wrapper. The
00047   // set of attributes handled by the attribute handler should remain
00048   // constant for its complete lifetime.
00049   boolean handlesAttribute(in nsIAtom name);
00050   
00051   void setAttribute(in nsIAtom name, in AString newValue);
00052   
00053   void removeAttribute(in nsIAtom name);
00054 
00055   // If the attribute 'name' is unknown the implementation should mark
00056   // the returned string as being 'null' (i.e. return 'null' in JS;
00057   // call SetIsVoid(PR_TRUE) in C++) rather than throw an exception.
00058   // A 'void' result will be translated into NS_CONTENT_ATTR_NOT_THERE
00059   // by the wrapper. An empty result will be translated into
00060   // NS_CONTENT_ATTR_NO_VALUE.
00061   AString getAttribute(in nsIAtom name);
00062   
00063   boolean hasAttribute(in nsIAtom name);
00064   
00065   unsigned long getAttributeCount();
00066 
00067   // note that this method should return an *atom* not a string.
00068   nsIAtom getAttributeNameAt(in unsigned long index);
00069 };