WebCore/khtml/dom/html_misc.h

   1 /*
   2  * This file is part of the DOM implementation for KDE.
   3  *
   4  * (C) 1999 Lars Knoll (knoll@kde.org)
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public License
  17  * along with this library; see the file COPYING.LIB.  If not, write to
  18  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * This file includes excerpts from the Document Object Model (DOM)
  22  * Level 1 Specification (Recommendation)
  23  * http://www.w3.org/TR/REC-DOM-Level-1/
  24  * Copyright © World Wide Web Consortium , (Massachusetts Institute of
  25  * Technology , Institut National de Recherche en Informatique et en
  26  * Automatique , Keio University ). All Rights Reserved.
  27  *
  28  */
  29 #ifndef HTML_MISC_H
  30 #define HTML_MISC_H
  31
  32 #include <dom/html_element.h>
  33 #include <qvaluelist.h>
  34
  35 namespace DOM {
  36
  37 class HTMLBaseFontElementImpl;
  38 class DOMString;
  39 class HTMLCollectionImpl;
  40
  41 /**
  42  * Base font. See the <a
  43  * href="http://www.w3.org/TR/REC-html40/present/graphics.html#edef-BASEFONT">
  44  * BASEFONT element definition </a> in HTML 4.0. This element is
  45  * deprecated in HTML 4.0.
  46  *
  47  */
  48 class HTMLBaseFontElement : public HTMLElement
  49 {
  50 public:
  51     HTMLBaseFontElement();
  52     HTMLBaseFontElement(const HTMLBaseFontElement &other);
  53     HTMLBaseFontElement(const Node &other) : HTMLElement()
  54          {(*this)=other;}
  55 protected:
  56     HTMLBaseFontElement(HTMLBaseFontElementImpl *impl);
  57 public:
  58
  59     HTMLBaseFontElement & operator = (const HTMLBaseFontElement &other);
  60     HTMLBaseFontElement & operator = (const Node &other);
  61
  62     ~HTMLBaseFontElement();
  63
  64     /**
  65      * Font color. See the <a href="http://www.w3.org/TR/REC-html40/">
  66      * color attribute definition </a> in HTML 4.0. This attribute is
  67      * deprecated in HTML 4.0.
  68      *
  69      */
  70     DOMString color() const;
  71
  72     /**
  73      * see @ref color
  74      */
  75     void setColor( const DOMString & );
  76
  77     /**
  78      * Font face identifier. See the <a
  79      * href="http://www.w3.org/TR/REC-html40/"> face attribute
  80      * definition </a> in HTML 4.0. This attribute is deprecated in
  81      * HTML 4.0.
  82      *
  83      */
  84     DOMString face() const;
  85
  86     /**
  87      * see @ref face
  88      */
  89     void setFace( const DOMString & );
  90
  91     /**
  92      * Font size. See the <a
  93      * href="http://www.w3.org/TR/REC-html40/present/graphics.html#adef-size-BASEFONT">
  94      * size attribute definition </a> in HTML 4.0. This attribute is
  95      * deprecated in HTML 4.0.
  96      *
  97      */
  98     DOMString size() const;
  99
 100     /**
 101      * see @ref size
 102      */
 103     void setSize( const DOMString & );
 104 };
 105
 106 // --------------------------------------------------------------------------
 107
 108 /**
 109  * An <code> HTMLCollection </code> is a list of nodes. An individual
 110  * node may be accessed by either ordinal index or the node's <code>
 111  * name </code> or <code> id </code> attributes. Note: Collections in
 112  * the HTML DOM are assumed to be live meaning that they are
 113  * automatically updated when the underlying document is changed.
 114  *
 115  */
 116 class HTMLCollection
 117 {
 118     friend class HTMLDocument;
 119     friend class HTMLSelectElement;
 120     friend class HTMLImageElement;
 121     friend class HTMLMapElement;
 122     friend class HTMLTableElement;
 123     friend class HTMLTableRowElement;
 124     friend class HTMLTableSectionElement;
 125     friend class HTMLElement;
 126
 127 public:
 128     HTMLCollection();
 129     HTMLCollection(const HTMLCollection &other);
 130     HTMLCollection(NodeImpl *base, int type);
 131
 132 public:
 133
 134     HTMLCollection & operator = (const HTMLCollection &other);
 135
 136     ~HTMLCollection();
 137
 138     /**
 139      * This attribute specifies the length or size of the list.
 140      *
 141      */
 142     unsigned long length() const;
 143
 144     /**
 145      * This method retrieves a node specified by ordinal index. Nodes
 146      * are numbered in tree order (depth-first traversal order).
 147      *
 148      * @param index The index of the node to be fetched. The index
 149      * origin is 0.
 150      *
 151      * @return The <code> Node </code> at the corresponding position
 152      * upon success. A value of <code> null </code> is returned if the
 153      * index is out of range.
 154      *
 155      */
 156     Node item ( unsigned long index ) const;
 157
 158     /**
 159      * This method retrieves a <code> Node </code> using a name. It
 160      * first searches for a <code> Node </code> with a matching <code>
 161      * id </code> attribute. If it doesn't find one, it then searches
 162      * for a <code> Node </code> with a matching <code> name </code>
 163      * attribute, but only on those elements that are allowed a name
 164      * attribute.
 165      *
 166      * @param name The name of the <code> Node </code> to be fetched.
 167      *
 168      * @return The <code> Node </code> with a <code> name </code> or
 169      * <code> id </code> attribute whose value corresponds to the
 170      * specified string. Upon failure (e.g., no node with this name
 171      * exists), returns <code> null </code> .
 172      *
 173      */
 174     Node namedItem ( const DOMString &name ) const;
 175
 176     /**
 177      * @internal
 178      * not part of the DOM
 179      */
 180     Node base() const;
 181     HTMLCollectionImpl *handle() const;
 182     bool isNull() const;
 183     // Fast iteration
 184     Node firstItem() const;
 185     Node nextItem() const;
 186     // In case of multiple items named the same way
 187     Node nextNamedItem( const DOMString &name ) const;
 188
 189     QValueList<Node> namedItems( const DOMString &name ) const;
 190
 191 protected:
 192     HTMLCollectionImpl *impl;
 193 };
 194
 195 class HTMLFormCollection : public HTMLCollection
 196 {
 197     friend class HTMLFormElement;
 198 protected:
 199     HTMLFormCollection(NodeImpl *base);
 200 };
 201
 202 }; //namespace
 203
 204 #endif