/usr/include/dom/dom_element.h is in kdelibs5-dev 4:4.8.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 | /*
* This file is part of the DOM implementation for KDE.
*
* Copyright 1999 Lars Knoll (knoll@kde.org)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* This file includes excerpts from the Document Object Model (DOM)
* Level 1 Specification (Recommendation)
* http://www.w3.org/TR/REC-DOM-Level-1/
* Copyright © World Wide Web Consortium , (Massachusetts Institute of
* Technology , Institut National de Recherche en Informatique et en
* Automatique , Keio University ). All Rights Reserved.
*
*/
#ifndef _DOM_ELEMENT_h_
#define _DOM_ELEMENT_h_
#include <khtml_export.h>
#include <dom/dom_node.h>
#include <dom/css_value.h>
namespace DOM {
class DOMString;
class AttrImpl;
class Element;
class ElementImpl;
class NamedAttrMapImpl;
class DocumentImpl;
/**
* The \c Attr interface represents an attribute in an
* \c Element object. Typically the allowable values for
* the attribute are defined in a document type definition.
*
* \c Attr objects inherit the \c Node
* interface, but since they are not actually child nodes of the
* element they describe, the DOM does not consider them part of the
* document tree. Thus, the \c Node attributes
* \c parentNode , \c previousSibling , and
* \c nextSibling have a null value for \c Attr
* objects. The DOM takes the view that attributes are properties of
* elements rather than having a separate identity from the elements
* they are associated with; this should make it more efficient to
* implement such features as default attributes associated with all
* elements of a given type. Furthermore, \c Attr nodes
* may not be immediate children of a \c DocumentFragment
* . However, they can be associated with \c Element nodes
* contained within a \c DocumentFragment . In short,
* users and implementors of the DOM need to be aware that \c Attr
* nodes have some things in common with other objects
* inheriting the \c Node interface, but they also are
* quite distinct.
*
* The attribute's effective value is determined as follows: if this
* attribute has been explicitly assigned any value, that value is the
* attribute's effective value; otherwise, if there is a declaration
* for this attribute, and that declaration includes a default value,
* then that default value is the attribute's effective value;
* otherwise, the attribute does not exist on this element in the
* structure model until it has been explicitly added. Note that the
* \c nodeValue attribute on the \c Attr
* instance can also be used to retrieve the string version of the
* attribute's value(s).
*
* In XML, where the value of an attribute can contain entity
* references, the child nodes of the \c Attr node provide
* a representation in which entity references are not expanded. These
* child nodes may be either \c Text or
* \c EntityReference nodes. Because the attribute type may be
* unknown, there are no tokenized attribute values.
*
*/
class KHTML_EXPORT Attr : public Node
{
friend class Element;
friend class Document;
friend class DocumentImpl;
friend class HTMLDocument;
friend class ElementImpl;
friend class NamedAttrMapImpl;
friend class AttrImpl;
public:
Attr();
Attr(const Node &other) : Node()
{(*this)=other;}
Attr(const Attr &other);
Attr & operator = (const Node &other);
Attr & operator = (const Attr &other);
~Attr();
/**
* Returns the name of this attribute.
*
*/
DOMString name() const;
/**
* If this attribute was explicitly given a value in the original
* document, this is \c true ; otherwise, it is
* \c false . Note that the implementation is in charge of
* this attribute, not the user. If the user changes the value of
* the attribute (even if it ends up having the same value as the
* default value) then the \c specified flag is
* automatically flipped to \c true . To re-specify
* the attribute as the default value from the DTD, the user must
* delete the attribute. The implementation will then make a new
* attribute available with \c specified set to
* \c false and the default value (if one exists).
*
* In summary:
* \li If the attribute has an assigned
* value in the document then \c specified is
* \c true , and the value is the assigned value.
*
* \li If the attribute has no assigned value in the
* document and has a default value in the DTD, then
* \c specified is \c false , and the value is
* the default value in the DTD.
*
* \li If the attribute has no assigned value in the
* document and has a value of #IMPLIED in the DTD, then the
* attribute does not appear in the structure model of the
* document.
*
*
*
*/
bool specified() const;
/**
* On retrieval, the value of the attribute is returned as a
* string. Character and general entity references are replaced
* with their values.
*
* On setting, this creates a \c Text node with the
* unparsed contents of the string.
*
*/
DOMString value() const;
/**
* see value
*/
void setValue( const DOMString & );
/**
* Introduced in DOM Level 2
*
* The Element node this attribute is attached to or null if this attribute
* is not in use.
*/
Element ownerElement() const;
protected:
Attr( AttrImpl *_impl );
};
class NodeList;
class Attr;
class DOMString;
/**
* By far the vast majority of objects (apart from text) that authors
* encounter when traversing a document are \c Element
* nodes. Assume the following XML document: <elementExample
* id="demo"> <subelement1/>
* <subelement2><subsubelement/></subelement2>
* </elementExample>
*
* When represented using DOM, the top node is an \c Element
* node for "elementExample", which contains two
* child \c Element nodes, one for "subelement1"
* and one for "subelement2". "subelement1"
* contains no child nodes.
*
* Elements may have attributes associated with them; since the
* \c Element interface inherits from \c Node
* , the generic \c Node interface method
* \c getAttributes may be used to retrieve the set of all
* attributes for an element. There are methods on the \c Element
* interface to retrieve either an \c Attr object
* by name or an attribute value by name. In XML, where an attribute
* value may contain entity references, an \c Attr object
* should be retrieved to examine the possibly fairly complex sub-tree
* representing the attribute value. On the other hand, in HTML, where
* all attributes have simple string values, methods to directly
* access an attribute value can safely be used as a convenience.
*
*/
class KHTML_EXPORT Element : public Node
{
friend class Document;
friend class DocumentFragment;
friend class HTMLDocument;
// friend class AttrImpl;
friend class Attr;
public:
Element();
Element(const Node &other) : Node()
{(*this)=other;}
Element(const Element &other);
Element & operator = (const Node &other);
Element & operator = (const Element &other);
~Element();
/**
* The name of the element. For example, in: <elementExample
* id="demo"> ... </elementExample> ,
* \c tagName has the value \c "elementExample"
* . Note that this is case-preserving in XML, as are all
* of the operations of the DOM. The HTML DOM returns the
* \c tagName of an HTML element in the canonical uppercase
* form, regardless of the case in the source HTML document.
*
*/
DOMString tagName() const;
/**
* Retrieves an attribute value by name.
*
* @param name The name of the attribute to retrieve.
*
* @return The \c Attr value as a string, or the empty
* string if that attribute does not have a specified or default
* value.
*
*/
DOMString getAttribute ( const DOMString &name );
/**
* Adds a new attribute. If an attribute with that name is already
* present in the element, its value is changed to be that of the
* value parameter. This value is a simple string, it is not
* parsed as it is being set. So any markup (such as syntax to be
* recognized as an entity reference) is treated as literal text,
* and needs to be appropriately escaped by the implementation
* when it is written out. In order to assign an attribute value
* that contains entity references, the user must create an
* \c Attr node plus any \c Text and
* \c EntityReference nodes, build the appropriate subtree,
* and use \c setAttributeNode to assign it as the
* value of an attribute.
*
* @param name The name of the attribute to create or alter.
*
* @param value Value to set in string form.
*
* @return
*
* @exception DOMException
* INVALID_CHARACTER_ERR: Raised if the specified name contains an
* invalid character.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
*/
void setAttribute ( const DOMString &name, const DOMString &value );
/**
* Removes an attribute by name. If the removed attribute has a
* default value it is immediately replaced.
*
* @param name The name of the attribute to remove.
*
* @return
*
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
*/
void removeAttribute ( const DOMString &name );
/**
* Retrieves an \c Attr node by name.
*
* @param name The name of the attribute to retrieve.
*
* @return The \c Attr node with the specified
* attribute name or \c null if there is no such
* attribute.
*
*/
Attr getAttributeNode ( const DOMString &name );
/**
* Adds a new attribute. If an attribute with that name is already
* present in the element, it is replaced by the new one.
*
* @param newAttr The \c Attr node to add to the
* attribute list.
*
* @return If the \c newAttr attribute replaces an
* existing attribute with the same name, the previously existing
* \c Attr node is returned, otherwise \c null
* is returned.
*
* @exception DOMException
* WRONG_DOCUMENT_ERR: Raised if \c newAttr was
* created from a different document than the one that created the
* element.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* INUSE_ATTRIBUTE_ERR: Raised if \c newAttr is
* already an attribute of another \c Element object.
* The DOM user must explicitly clone \c Attr nodes to
* re-use them in other elements.
*
*/
Attr setAttributeNode ( const Attr &newAttr );
/**
* Removes the specified attribute.
*
* @param oldAttr The \c Attr node to remove from the
* attribute list. If the removed \c Attr has a
* default value it is immediately replaced.
*
* @return The \c Attr node that was removed.
*
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* NOT_FOUND_ERR: Raised if \c oldAttr is not an
* attribute of the element.
*
*/
Attr removeAttributeNode ( const Attr &oldAttr );
/**
* Returns a \c NodeList of all descendant elements
* with a given tag name, in the order in which they would be
* encountered in a preorder traversal of the \c Element
* tree.
*
* @param name The name of the tag to match on. The special value
* "*" matches all tags.
*
* @return A list of matching \c Element nodes.
*
*/
NodeList getElementsByTagName ( const DOMString &name );
/**
* Introduced in DOM Level 2
* Returns a NodeList of all the descendant Elements with a given local
* name and namespace URI in the order in which they are encountered in a
* preorder traversal of this Element tree.
*
* @param namespaceURI The namespace URI of the elements to match on. The
* special value "*" matches all namespaces.
*
* @param localName The local name of the elements to match on. The special
* value "*" matches all local names.
*
* @return A new NodeList object containing all the matched Elements.
*/
NodeList getElementsByTagNameNS ( const DOMString &namespaceURI,
const DOMString &localName );
/**
* Introduced in HTML 5.
* No Exceptions.
*
* Returns a \c NodeList of all the \c Element 's
* with a given class name in the order in which they
* would be encountered in a preorder traversal of the
* \c Document tree.
*
* @param tagname An unordered set of unique space-separated
* tokens representing classes.
*
* @return A new \c NodeList object containing all the
* matched \c Element s.
*
* @since 4.1
*/
NodeList getElementsByClassName ( const DOMString &className );
/**
* Introduced in DOM Level 2.
*
* No Exceptions.
*
* Retrieves an attribute value by local name and namespace URI. HTML-only
* DOM implementations do not need to implement this method.
*
* @param namespaceURI The namespace URI of the attribute to retrieve.
*
* @param localName The local name of the attribute to retrieve.
*
* @return The Attr value as a string, or the empty string if that
* attribute does not have a specified or default value.
*/
DOMString getAttributeNS ( const DOMString &namespaceURI,
const DOMString &localName );
/**
* Introduced in DOM Level 2
*
* Adds a new attribute. If an attribute with the same local name and
* namespace URI is already present on the element, its prefix is changed
* to be the prefix part of the qualifiedName, and its value is changed to
* be the value parameter. This value is a simple string; it is not parsed
* as it is being set. So any markup (such as syntax to be recognized as an
* entity reference) is treated as literal text, and needs to be
* appropriately escaped by the implementation when it is written out. In
* order to assign an attribute value that contains entity references, the
* user must create an Attr node plus any Text and EntityReference nodes,
* build the appropriate subtree, and use setAttributeNodeNS or
* setAttributeNode to assign it as the value of an attribute.
*
* HTML-only DOM implementations do not need to implement this method.
*
* @param namespaceURI The namespace URI of the attribute to create or
* alter.
*
* @param qualifiedName The qualified name of the attribute to create or
* alter.
*
* @param value The value to set in string form.
*
* @exception DOMException
* INVALID_CHARACTER_ERR: Raised if the specified qualified name contains
* an illegal character.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the
* qualifiedName has a prefix and the namespaceURI is null, if the
* qualifiedName has a prefix that is "xml" and the namespaceURI is
* different from "http://www.w3.org/XML/1998/namespace", or if the
* qualifiedName is "xmlns" and the namespaceURI is different from
* "http://www.w3.org/2000/xmlns/".
*/
void setAttributeNS ( const DOMString &namespaceURI,
const DOMString &qualifiedName,
const DOMString &value );
/**
* Introduced in DOM Level 2
*
* Removes an attribute by local name and namespace URI. If the removed
* attribute has a default value it is immediately replaced. The replacing
* attribute has the same namespace URI and local name, as well as the
* original prefix.
*
* HTML-only DOM implementations do not need to implement this method.
*
* @param namespaceURI The namespace URI of the attribute to remove.
*
* @param localName The local name of the attribute to remove.
*
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
void removeAttributeNS ( const DOMString &namespaceURI,
const DOMString &localName );
/**
* Introduced in DOM Level 2
*
* Retrieves an Attr node by local name and namespace URI. HTML-only DOM
* implementations do not need to implement this method.
*
* @param namespaceURI The namespace URI of the attribute to retrieve.
*
* @param localName The local name of the attribute to retrieve.
*
* @return The Attr node with the specified attribute local name and
* namespace URI or null if there is no such attribute.
*/
Attr getAttributeNodeNS ( const DOMString &namespaceURI,
const DOMString &localName );
/**
* Introduced in DOM Level 2
*
* Adds a new attribute. If an attribute with that local name and that
* namespace URI is already present in the element, it is replaced by the
* new one.
*
* HTML-only DOM implementations do not need to implement this method.
*
* @param newAttr The Attr node to add to the attribute list.
*
* @return If the newAttr attribute replaces an existing attribute with the
* same local name and namespace URI, the replaced Attr node is returned,
* otherwise null is returned.
*
* @exception DOMException
* WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different
* document than the one that created the element.
*
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*
* INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of
* another Element object. The DOM user must explicitly clone Attr nodes to
* re-use them in other elements.
*/
Attr setAttributeNodeNS ( const Attr &newAttr );
/**
* Returns true when an attribute with a given name is specified on this
* element or has a default value, false otherwise.
* Introduced in DOM Level 2.
*
* @param name The name of the attribute to look for.
*
* @return true if an attribute with the given name is specified on this
* element or has a default value, false otherwise.
*/
bool hasAttribute( const DOMString& name );
/**
* Introduced in DOM Level 2
*
* Returns true when an attribute with a given local name and namespace URI
* is specified on this element or has a default value, false otherwise.
* HTML-only DOM implementations do not need to implement this method.
*
* @param namespaceURI The namespace URI of the attribute to look for.
*
* @param localName The local name of the attribute to look for.
*
* @return true if an attribute with the given local name and namespace URI
* is specified or has a default value on this element, false otherwise.
*/
bool hasAttributeNS ( const DOMString &namespaceURI,
const DOMString &localName );
/**
* Introduced in DOM Level 2
* This method is from the CSSStyleDeclaration interface
*
* The style attribute
*/
CSSStyleDeclaration style ( );
/**
* Introduced in DOM level 3
* This method is part of the ElementTraversal interface
*
* The first child node which is of nodeType ELEMENT_NODE.
*
*/
Element firstElementChild ( ) const;
/**
* Introduced in DOM level 3
* This method is part of the ElementTraversal interface
*
* @return The last child node of that element which is of nodeType ELEMENT_NODE.
*
*/
Element lastElementChild ( ) const;
/**
* Introduced in DOM level 3
* This method is part of the ElementTraversal interface
*
* @return The sibling node of that element which most immediately precedes that element in document order,
* and which is of nodeType ELEMENT_NODE
*
*/
Element previousElementSibling ( ) const;
/**
* Introduced in DOM level 3
* This method is part of the ElementTraversal interface
*
* @return The sibling node of that element which most immediately follows that element in document order,
* and which is of nodeType ELEMENT_NODE
*
*/
Element nextElementSibling ( ) const;
/**
* Introduced in DOM level 3
* This method is part of the ElementTraversal interface
*
* @return The current number of child nodes of that element which are of nodeType ELEMENT_NODE
*
*/
unsigned long childElementCount ( ) const;
/**
* Introduced in Selectors Level 1.
*
* Returns the first (in document order) element in this element's subtree
* matching the given CSS selector @p query.
*
* @since 4.5
*/
Element querySelector(const DOMString& query) const;
/**
* Introduced in Selectors Level 1.
*
* Returns all (in document order) elements in this element's subtree
* matching the given CSS selector @p query. Note that the returned NodeList
* is static and not live, and will not be updated when the document
* changes
*
* @since 4.5
*/
NodeList querySelectorAll(const DOMString& query) const;
/**
* not part of the official DOM
*
* This method will always reflect the editability setting of this
* element as specified by a direct or indirect (that means, inherited)
* assignment to contentEditable or the respective CSS rule, even if
* design mode is active.
*
* @return whether this element is editable.
* @see setContentEditable
*/
bool contentEditable() const;
/**
* not part of the official DOM
*
* This element can be made editable by setting its contentEditable
* property to @p true. The setting will be inherited to its children
* as well.
*
* Setting or clearing contentEditable when design mode is active will
* take no effect. However, its status will still be propagated to all
* child elements.
*
* @param enabled @p true to make this element editable, @p false
* otherwise.
* @see DOM::Document::designMode
*/
void setContentEditable(bool enabled);
/**
* @internal
* not part of the DOM
*/
bool isHTMLElement() const;
/**
* KHTML extension to DOM
* This method returns the associated form element.
* returns null if this element is not a form-like element
* or if this elment is not in the scope of a form element.
*/
Element form() const;
static bool khtmlValidAttrName(const DOMString &name);
static bool khtmlValidPrefix(const DOMString &name);
static bool khtmlValidQualifiedName(const DOMString &name);
static bool khtmlMalformedQualifiedName(const DOMString &name);
static bool khtmlMalformedPrefix(const DOMString &name);
protected:
Element(ElementImpl *_impl);
};
} //namespace
#endif
|