• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KHTML

  • DOM
  • DocumentFragment
Public Member Functions | Protected Member Functions | List of all members
DOM::DocumentFragment Class Reference

#include <dom_doc.h>

Inheritance diagram for DOM::DocumentFragment:
Inheritance graph
[legend]

Public Member Functions

 DocumentFragment ()
 
 DocumentFragment (const DocumentFragment &other)
 
 DocumentFragment (const Node &other)
 
 ~DocumentFragment ()
 
DocumentFragment & operator= (const Node &other)
 
DocumentFragment & operator= (const DocumentFragment &other)
 
Element querySelector (const DOMString &query) const
 
NodeList querySelectorAll (const DOMString &query) const
 
- Public Member Functions inherited from DOM::Node
 Node ()
 
 Node (const Node &other)
 
 Node (NodeImpl *_impl)
 
virtual ~Node ()
 
void addEventListener (const DOMString &type, EventListener *listener, const bool useCapture)
 
Node appendChild (const Node &newChild)
 
void applyChanges ()
 
NamedNodeMap attributes () const
 
NodeList childNodes () const
 
Node cloneNode (bool deep)
 
unsigned compareDocumentPosition (const DOM::Node &other)
 
bool dispatchEvent (const Event &evt)
 
quint32 elementId () const
 
Node firstChild () const
 
void getCursor (int offset, int &_x, int &_y, int &height)
 
QRect getRect ()
 
NodeImpl * handle () const
 
bool hasAttributes ()
 
bool hasChildNodes ()
 
unsigned long index () const
 
Node insertBefore (const Node &newChild, const Node &refChild)
 
bool isNull () const
 
bool isSupported (const DOMString &feature, const DOMString &version) const
 
Node lastChild () const
 
DOMString localName () const
 
DOMString namespaceURI () const
 
Node nextSibling () const
 
DOMString nodeName () const
 
unsigned short nodeType () const
 
DOMString nodeValue () const
 
void normalize ()
 
bool operator!= (const Node &other) const
 
Node & operator= (const Node &other)
 
bool operator== (const Node &other) const
 
Document ownerDocument () const
 
Node parentNode () const
 
DOMString prefix () const
 
Node previousSibling () const
 
Node removeChild (const Node &oldChild)
 
void removeEventListener (const DOMString &type, EventListener *listener, bool useCapture)
 
Node replaceChild (const Node &newChild, const Node &oldChild)
 
void setNodeValue (const DOMString &)
 
void setPrefix (const DOMString &prefix)
 
void setTextContent (const DOMString &text)
 
DOMString textContent () const
 
QString toHTML ()
 

Protected Member Functions

 DocumentFragment (DocumentFragmentImpl *i)
 

Additional Inherited Members

- Public Types inherited from DOM::Node
enum  DocumentPosition {
  DOCUMENT_POSITION_DISCONNECTED = 0x01, DOCUMENT_POSITION_PRECEDING = 0x02, DOCUMENT_POSITION_FOLLOWING = 0x04, DOCUMENT_POSITION_CONTAINS = 0x08,
  DOCUMENT_POSITION_CONTAINED_BY = 0x10, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20
}
 
enum  NodeType {
  ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,
  ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,
  DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12,
  XPATH_NAMESPACE_NODE = 13
}
 
- Protected Attributes inherited from DOM::Node
NodeImpl * impl
 

Detailed Description

DocumentFragment is a "lightweight" or "minimal" Document object.

It is very common to want to be able to extract a portion of a document's tree or to create a new fragment of a document. Imagine implementing a user command like cut or rearranging a document by moving fragments around. It is desirable to have an object which can hold such fragments and it is quite natural to use a Node for this purpose. While it is true that a Document object could fulfil this role, a Document object can potentially be a heavyweight object, depending on the underlying implementation. What is really needed for this is a very lightweight object. DocumentFragment is such an object.

Furthermore, various operations – such as inserting nodes as children of another Node – may take DocumentFragment objects as arguments; this results in all the child nodes of the DocumentFragment being moved to the child list of this node.

The children of a DocumentFragment node are zero or more nodes representing the tops of any sub-trees defining the structure of the document. DocumentFragment nodes do not need to be well-formed XML documents (although they do need to follow the rules imposed upon well-formed XML parsed entities, which can have multiple top nodes). For example, a DocumentFragment might have only one child and that child node could be a Text node. Such a structure model represents neither an HTML document nor a well-formed XML document.

When a DocumentFragment is inserted into a Document (or indeed any other Node that may take children) the children of the DocumentFragment and not the DocumentFragment itself are inserted into the Node . This makes the DocumentFragment very useful when the user wishes to create nodes that are siblings; the DocumentFragment acts as the parent of these nodes so that the user can use the standard methods from the Node interface, such as insertBefore() and appendChild() .

Definition at line 1041 of file dom_doc.h.

Constructor & Destructor Documentation

DOM::DocumentFragment::DocumentFragment ( )

Definition at line 621 of file dom_doc.cpp.

DOM::DocumentFragment::DocumentFragment ( const DocumentFragment &  other)

Definition at line 625 of file dom_doc.cpp.

DOM::DocumentFragment::DocumentFragment ( const Node &  other)
inline

Definition at line 1050 of file dom_doc.h.

DOM::DocumentFragment::~DocumentFragment ( )

Definition at line 649 of file dom_doc.cpp.

DOM::DocumentFragment::DocumentFragment ( DocumentFragmentImpl *  i)
protected

Definition at line 673 of file dom_doc.cpp.

Member Function Documentation

DocumentFragment & DOM::DocumentFragment::operator= ( const Node &  other)

Definition at line 629 of file dom_doc.cpp.

DocumentFragment & DOM::DocumentFragment::operator= ( const DocumentFragment &  other)

Definition at line 643 of file dom_doc.cpp.

Element DOM::DocumentFragment::querySelector ( const DOMString &  query) const

Introduced in Selectors Level 1.

Returns the first (in document order) element in this fragment matching the given CSS selector query.

Since
4.5

Definition at line 653 of file dom_doc.cpp.

NodeList DOM::DocumentFragment::querySelectorAll ( const DOMString &  query) const

Introduced in Selectors Level 1.

Returns all (in document order) elements in this fragment matching the given CSS selector query. Note that the returned NodeList is static and not live, and will not be updated when the document changes

Since
4.5

Definition at line 663 of file dom_doc.cpp.


The documentation for this class was generated from the following files:
  • dom_doc.h
  • dom_doc.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:51:23 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KHTML

Skip menu "KHTML"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal