KHTML
#include <html_document.h>
Protected Member Functions | |
HTMLDocument (HTMLDocumentImpl *impl) | |
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
An HTMLDocument
is the root of the HTML hierarchy and holds the entire content.
Beside providing access to the hierarchy, it also provides some convenience methods for accessing certain sets of information from the document.
The following properties have been deprecated in favor of the corresponding ones for the BODY element:
alinkColor
background
bgColor
fgColor
linkColor
vlinkColor
Definition at line 73 of file html_document.h.
Constructor & Destructor Documentation
HTMLDocument::HTMLDocument | ( | ) |
Definition at line 33 of file html_document.cpp.
HTMLDocument::HTMLDocument | ( | KHTMLView * | parent | ) |
The parent is the widget the document should render itself in.
Rendering information (like sizes, etc...) is only created if parent != 0
Definition at line 40 of file html_document.cpp.
HTMLDocument::HTMLDocument | ( | const HTMLDocument & | other | ) |
Definition at line 47 of file html_document.cpp.
|
inline |
Definition at line 87 of file html_document.h.
|
protected |
Definition at line 51 of file html_document.cpp.
HTMLDocument::~HTMLDocument | ( | ) |
Definition at line 78 of file html_document.cpp.
Member Function Documentation
HTMLCollection HTMLDocument::all | ( | ) | const |
Not part of the DOM.
A collection of all the IMG
, OBJECT
, AREA
, A
, forms and anchor elements of a document.
Definition at line 182 of file html_document.cpp.
HTMLCollection HTMLDocument::anchors | ( | ) | const |
A collection of all the anchor ( A
) elements in a document with a value for the name
attribute.
Note. For reasons of backwards compatibility, the returned set of anchors only contains those anchors created with the name
attribute, not those created with the id
attribute.
Definition at line 176 of file html_document.cpp.
HTMLCollection HTMLDocument::applets | ( | ) | const |
A collection of all the OBJECT
elements that include applets and APPLET
( deprecated ) elements in a document.
Definition at line 146 of file html_document.cpp.
HTMLElement HTMLDocument::body | ( | ) | const |
The element that contains the content for the document.
In documents with BODY
contents, returns the BODY
element, and in frameset documents, this returns the outermost FRAMESET
element.
Definition at line 124 of file html_document.cpp.
void HTMLDocument::close | ( | ) |
Closes a document stream opened by open()
and forces rendering.
- Returns
Definition at line 207 of file html_document.cpp.
not part of the DOM
converts the given (potentially relative) URL in a full-qualified one, using the baseURL / document URL for the missing parts.
Definition at line 100 of file html_document.cpp.
DOMString HTMLDocument::cookie | ( | ) | const |
The cookies associated with this document.
If there are none, the value is an empty string. Otherwise, the value is a string: a semicolon-delimited list of "name, value" pairs for all the cookies associated with the page. For example, name=value
;expires=date .
Definition at line 188 of file html_document.cpp.
DOMString HTMLDocument::domain | ( | ) | const |
The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.
Definition at line 106 of file html_document.cpp.
HTMLCollection HTMLDocument::forms | ( | ) | const |
A collection of all the forms of a document.
Definition at line 164 of file html_document.cpp.
Returns the (possibly empty) collection of elements whose name
value is given by elementName
.
- Parameters
-
elementName The name
attribute value for an element.
- Returns
- The matching elements.
Definition at line 225 of file html_document.cpp.
HTMLCollection HTMLDocument::images | ( | ) | const |
A collection of all the IMG
elements in a document.
The behavior is limited to IMG
elements for backwards compatibility.
Definition at line 140 of file html_document.cpp.
DOMString HTMLDocument::lastModified | ( | ) | const |
Not part of the DOM.
The date the document was last modified.
Definition at line 112 of file html_document.cpp.
HTMLCollection HTMLDocument::layers | ( | ) | const |
A collection of all the layers of a document.
Definition at line 170 of file html_document.cpp.
HTMLCollection HTMLDocument::links | ( | ) | const |
A collection of all AREA
elements and anchor ( A
) elements in a document with a value for the href
attribute.
Definition at line 158 of file html_document.cpp.
void HTMLDocument::open | ( | ) |
Note.
This method and the ones following allow a user to add to or replace the structure model of a document using strings of unparsed HTML. At the time of writing alternate methods for providing similar functionality for both HTML and XML documents were being considered. The following methods may be deprecated at some point in the future in favor of a more general-purpose mechanism.
Open a document stream for writing. If a document exists in the target, this method clears it.
- Returns
Definition at line 201 of file html_document.cpp.
HTMLDocument & HTMLDocument::operator= | ( | const HTMLDocument & | other | ) |
Definition at line 72 of file html_document.cpp.
HTMLDocument & HTMLDocument::operator= | ( | const Node & | other | ) |
Definition at line 55 of file html_document.cpp.
DOMString HTMLDocument::referrer | ( | ) | const |
Returns the URI of the page that linked to this page.
The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).
Definition at line 94 of file html_document.cpp.
HTMLCollection HTMLDocument::scripts | ( | ) | const |
A collection of all the scripts in the document.
Definition at line 152 of file html_document.cpp.
void HTMLDocument::setBody | ( | const HTMLElement & | _body | ) |
see body
Definition at line 130 of file html_document.cpp.
void HTMLDocument::setCookie | ( | const DOMString & | value | ) |
see cookie
Definition at line 194 of file html_document.cpp.
void HTMLDocument::setTitle | ( | const DOMString & | value | ) |
see title
Definition at line 88 of file html_document.cpp.
DOMString HTMLDocument::title | ( | ) | const |
The title of a document as specified by the TITLE
element in the head of the document.
Definition at line 82 of file html_document.cpp.
DOMString HTMLDocument::URL | ( | ) | const |
The absolute URI of the document.
Definition at line 118 of file html_document.cpp.
void HTMLDocument::write | ( | const DOMString & | text | ) |
Write a string of text to a document stream opened by open()
.
The text is parsed into the document's structure model.
- Parameters
-
text The string to be parsed into some structure in the document structure model.
- Returns
Definition at line 213 of file html_document.cpp.
void HTMLDocument::writeln | ( | const DOMString & | text | ) |
Write a string of text followed by a newline character to a document stream opened by open()
.
The text is parsed into the document's structure model.
- Parameters
-
text The string to be parsed into some structure in the document structure model.
- Returns
Definition at line 219 of file html_document.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:26:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.