Back to index

lightning-sunbird  0.9+nobinonly
nsIAttribute.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; 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 mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Peter Van der Beken <peterv@netscape.com>
00024  *   Allan Beaufour <allan@beaufour.dk>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef nsIAttribute_h___
00041 #define nsIAttribute_h___
00042 
00043 #include "nsISupports.h"
00044 #include "nsINodeInfo.h"
00045 #include "nsIContent.h"
00046 #include "nsPropertyTable.h"
00047 
00048 class nsIAtom;
00049 class nsDOMAttributeMap;
00050 
00051 #define NS_IATTRIBUTE_IID  \
00052  {0x4940cc50, 0x2ede, 0x4883,        \
00053  {0x95, 0xf5, 0x53, 0xdb, 0x50, 0x50, 0x13, 0x3e}}
00054 
00055 class nsIAttribute : public nsISupports
00056 {
00057 public:
00058   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IATTRIBUTE_IID)
00059 
00060   virtual void SetMap(nsDOMAttributeMap *aMap) = 0;
00061   
00062   nsDOMAttributeMap *GetMap()
00063   {
00064     return mAttrMap;
00065   }
00066 
00067   nsINodeInfo *NodeInfo()
00068   {
00069     return mNodeInfo;
00070   }
00071 
00072   virtual nsIContent* GetContent() const = 0;
00073 
00074   nsIDocument *GetOwnerDoc() const
00075   {
00076     nsIContent* content = GetContent();
00077     return content ? content->GetOwnerDoc() : mNodeInfo->GetDocument();
00078   }
00079 
00080   /*
00081    * Methods for manipulating content node properties.  For documentation on
00082    * properties, see nsPropertyTable.h.
00083    */
00084   virtual void* GetProperty(nsIAtom  *aPropertyName,
00085                             nsresult *aStatus = nsnull) = 0;
00086 
00087   virtual nsresult SetProperty(nsIAtom                   *aPropertyName,
00088                                void                      *aValue,
00089                                NSPropertyDtorFunc         aDtor = nsnull) = 0;
00090 
00091   virtual nsresult DeleteProperty(nsIAtom *aPropertyName) = 0;
00092 
00093   virtual void* UnsetProperty(nsIAtom  *aPropertyName,
00094                               nsresult *aStatus = nsnull) = 0;
00095 
00096 protected:
00097   nsIAttribute(nsDOMAttributeMap *aAttrMap, nsINodeInfo *aNodeInfo)
00098     : mAttrMap(aAttrMap), mNodeInfo(aNodeInfo)
00099   {
00100   }
00101 
00102   nsDOMAttributeMap *mAttrMap; // WEAK
00103   nsCOMPtr<nsINodeInfo> mNodeInfo; // STRONG
00104 
00105 private:
00106   nsIAttribute(); // Not to be implemented.
00107 };
00108 
00109 #endif /* nsIAttribute_h___ */