WebCore/dom/Element.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
   4  *           (C) 2001 Peter Kelly (pmk@post.com)
   5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
   6  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public License
  19  * along with this library; see the file COPYING.LIB.  If not, write to
  20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #ifndef Element_h
  26 #define Element_h
  27
  28 #include "ContainerNode.h"
  29 #include "QualifiedName.h"
  30 #include "ScrollTypes.h"
  31
  32 namespace WebCore {
  33
  34 class Attr;
  35 class Attribute;
  36 class CSSStyleDeclaration;
  37 class ElementRareData;
  38 class IntSize;
  39
  40 class Element : public ContainerNode {
  41 public:
  42     Element(const QualifiedName&, Document*);
  43     ~Element();
  44
  45     const AtomicString& getIDAttribute() const;
  46     bool hasAttribute(const QualifiedName&) const;
  47     const AtomicString& getAttribute(const QualifiedName&) const;
  48     void setAttribute(const QualifiedName&, const AtomicString& value, ExceptionCode&);
  49     void removeAttribute(const QualifiedName&, ExceptionCode&);
  50
  51     bool hasAttributes() const;
  52
  53     bool hasAttribute(const String& name) const;
  54     bool hasAttributeNS(const String& namespaceURI, const String& localName) const;
  55
  56     const AtomicString& getAttribute(const String& name) const;
  57     const AtomicString& getAttributeNS(const String& namespaceURI, const String& localName) const;
  58
  59     void setAttribute(const AtomicString& name, const AtomicString& value, ExceptionCode&);
  60     void setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value, ExceptionCode&);
  61
  62     void scrollIntoView (bool alignToTop = true);
  63     void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
  64
  65     void scrollByUnits(int units, ScrollGranularity);
  66     void scrollByLines(int lines);
  67     void scrollByPages(int pages);
  68
  69     int offsetLeft();
  70     int offsetTop();
  71     int offsetWidth();
  72     int offsetHeight();
  73     Element* offsetParent();
  74     int clientLeft();
  75     int clientTop();
  76     int clientWidth();
  77     int clientHeight();
  78     int scrollLeft();
  79     int scrollTop();
  80     void setScrollLeft(int);
  81     void setScrollTop(int);
  82     int scrollWidth();
  83     int scrollHeight();
  84
  85     void removeAttribute(const String& name, ExceptionCode&);
  86     void removeAttributeNS(const String& namespaceURI, const String& localName, ExceptionCode&);
  87
  88     PassRefPtr<Attr> getAttributeNode(const String& name);
  89     PassRefPtr<Attr> getAttributeNodeNS(const String& namespaceURI, const String& localName);
  90     PassRefPtr<Attr> setAttributeNode(Attr*, ExceptionCode&);
  91     PassRefPtr<Attr> setAttributeNodeNS(Attr*, ExceptionCode&);
  92     PassRefPtr<Attr> removeAttributeNode(Attr*, ExceptionCode&);
  93
  94     virtual CSSStyleDeclaration* style();
  95
  96     const QualifiedName& tagQName() const { return m_tagName; }
  97     String tagName() const { return nodeName(); }
  98     bool hasTagName(const QualifiedName& tagName) const { return m_tagName.matches(tagName); }
  99
 100     // A fast function for checking the local name against another atomic string.
 101     bool hasLocalName(const AtomicString& other) const { return m_tagName.localName() == other; }
 102     bool hasLocalName(const QualifiedName& other) const { return m_tagName.localName() == other.localName(); }
 103
 104     const AtomicString& localName() const { return m_tagName.localName(); }
 105     const AtomicString& prefix() const { return m_tagName.prefix(); }
 106     virtual void setPrefix(const AtomicString&, ExceptionCode&);
 107     const AtomicString& namespaceURI() const { return m_tagName.namespaceURI(); }
 108
 109     virtual KURL baseURI() const;
 110
 111     // DOM methods overridden from parent classes
 112     virtual NodeType nodeType() const;
 113     virtual PassRefPtr<Node> cloneNode(bool deep);
 114     virtual String nodeName() const;
 115     virtual void insertedIntoDocument();
 116     virtual void removedFromDocument();
 117     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
 118
 119     void normalizeAttributes();
 120
 121     virtual bool isInputTypeHidden() const { return false; }
 122     virtual bool isPasswordField() const { return false; }
 123
 124     String nodeNamePreservingCase() const;
 125
 126     // convenience methods which ignore exceptions
 127     void setAttribute(const QualifiedName&, const AtomicString& value);
 128     void setBooleanAttribute(const QualifiedName& name, bool);
 129
 130     virtual NamedAttrMap* attributes() const;
 131     NamedAttrMap* attributes(bool readonly) const;
 132
 133     // This method is called whenever an attribute is added, changed or removed.
 134     virtual void attributeChanged(Attribute*, bool preserveDecls = false);
 135
 136     // not part of the DOM
 137     void setAttributeMap(PassRefPtr<NamedAttrMap>);
 138
 139     virtual void copyNonAttributeProperties(const Element* source) {}
 140
 141     virtual void attach();
 142     virtual void detach();
 143     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
 144     virtual void recalcStyle(StyleChange = NoChange);
 145
 146     virtual RenderStyle* computedStyle();
 147
 148     virtual bool childTypeAllowed(NodeType);
 149
 150     virtual PassRefPtr<Attribute> createAttribute(const QualifiedName&, const AtomicString& value);
 151
 152     void dispatchAttrRemovalEvent(Attribute*);
 153     void dispatchAttrAdditionEvent(Attribute*);
 154
 155     virtual void accessKeyAction(bool sendToAnyEvent) { }
 156
 157     virtual bool isURLAttribute(Attribute*) const;
 158     virtual const QualifiedName& imageSourceAttributeName() const;
 159     virtual String target() const { return String(); }
 160
 161     virtual void focus(bool restorePreviousSelection = true);
 162     virtual void updateFocusAppearance(bool restorePreviousSelection);
 163     void blur();
 164
 165 #ifndef NDEBUG
 166     virtual void formatForDebugger(char* buffer, unsigned length) const;
 167 #endif
 168
 169     bool contains(const Node*) const;
 170
 171     String innerText() const;
 172     String outerText() const;
 173
 174     virtual String title() const;
 175
 176     String openTagStartToString() const;
 177
 178     void updateId(const AtomicString& oldId, const AtomicString& newId);
 179
 180     IntSize minimumSizeForResizing() const;
 181     void setMinimumSizeForResizing(const IntSize&);
 182
 183     // Use Document::registerForDocumentActivationCallbacks() to subscribe these
 184     virtual void documentWillBecomeInactive() { }
 185     virtual void documentDidBecomeActive() { }
 186
 187     bool isFinishedParsingChildren() const { return m_parsingChildrenFinished; }
 188     virtual void finishParsingChildren();
 189     virtual void beginParsingChildren() { m_parsingChildrenFinished = false; }
 190
 191     // ElementTraversal API
 192     Element* firstElementChild() const;
 193     Element* lastElementChild() const;
 194     Element* previousElementSibling() const;
 195     Element* nextElementSibling() const;
 196     unsigned childElementCount() const;
 197
 198 private:
 199     virtual void createAttributeMap() const;
 200
 201     virtual void updateStyleAttribute() const {}
 202
 203 #if ENABLE(SVG)
 204     virtual void updateAnimatedSVGAttribute(const String&) const {}
 205 #endif
 206
 207     void updateFocusAppearanceSoonAfterAttach();
 208     void cancelFocusAppearanceUpdate();
 209
 210     virtual const AtomicString& virtualPrefix() const { return prefix(); }
 211     virtual const AtomicString& virtualLocalName() const { return localName(); }
 212     virtual const AtomicString& virtualNamespaceURI() const { return namespaceURI(); }
 213
 214     QualifiedName m_tagName;
 215     virtual NodeRareData* createRareData();
 216
 217 protected:
 218     ElementRareData* rareData() const;
 219     ElementRareData* ensureRareData();
 220
 221     mutable RefPtr<NamedAttrMap> namedAttrMap;
 222
 223     // These two bits are really used by the StyledElement subclass, but they are pulled up here in order to be shared with other
 224     // Element bits.
 225     mutable bool m_isStyleAttributeValid : 1;
 226     mutable bool m_synchronizingStyleAttribute : 1;
 227
 228 #if ENABLE(SVG)
 229     // These bit is are used by SVGElement subclasses, and it lives here for the same reason as above.
 230     mutable bool m_areSVGAttributesValid : 1;
 231     mutable bool m_synchronizingSVGAttributes : 1;
 232 #endif
 233
 234 private:
 235     bool m_parsingChildrenFinished : 1;
 236 };
 237
 238 inline bool Node::hasTagName(const QualifiedName& name) const
 239 {
 240     return isElementNode() && static_cast<const Element*>(this)->hasTagName(name);
 241 }
 242
 243 inline bool Node::hasAttributes() const
 244 {
 245     return isElementNode() && static_cast<const Element*>(this)->hasAttributes();
 246 }
 247
 248 inline NamedAttrMap* Node::attributes() const
 249 {
 250     return isElementNode() ? static_cast<const Element*>(this)->attributes() : 0;
 251 }
 252
 253 } //namespace
 254
 255 #endif