content/base/public/nsIAttribute.h

   1 /* -*- Mode: C++; 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 mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Peter Van der Beken <peterv@netscape.com>
  24  *   Allan Beaufour <allan@beaufour.dk>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsIAttribute_h___
  41 #define nsIAttribute_h___
  42
  43 #include "nsINode.h"
  44
  45 class nsDOMAttributeMap;
  46 class nsIContent;
  47
  48 #define NS_IATTRIBUTE_IID  \
  49 { 0x68b13198, 0x6d81, 0x4ab6, \
  50   { 0xb9, 0x98, 0xd0, 0xa4, 0x55, 0x82, 0x5f, 0xb1 } }
  51
  52 class nsIAttribute : public nsINode
  53 {
  54 public:
  55   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IATTRIBUTE_IID)
  56
  57   virtual void SetMap(nsDOMAttributeMap *aMap) = 0;
  58
  59   nsDOMAttributeMap *GetMap()
  60   {
  61     return mAttrMap;
  62   }
  63
  64   nsINodeInfo *NodeInfo()
  65   {
  66     return mNodeInfo;
  67   }
  68
  69   virtual nsIContent* GetContent() const = 0;
  70
  71   /**
  72    * Called when our ownerElement is moved into a new document.
  73    * Updates the nodeinfo of this node.
  74    */
  75   virtual nsresult SetOwnerDocument(nsIDocument* aDocument) = 0;
  76
  77 protected:
  78 #ifdef MOZILLA_INTERNAL_API
  79   nsIAttribute(nsDOMAttributeMap *aAttrMap, nsINodeInfo *aNodeInfo)
  80     : nsINode(aNodeInfo), mAttrMap(aAttrMap)
  81   {
  82   }
  83 #endif //MOZILLA_INTERNAL_API
  84
  85   nsDOMAttributeMap *mAttrMap; // WEAK
  86 };
  87
  88 NS_DEFINE_STATIC_IID_ACCESSOR(nsIAttribute, NS_IATTRIBUTE_IID)
  89
  90 #endif /* nsIAttribute_h___ */