WeHtmlDocument Class Reference

Web document. Entry point to parsed document. More...

#include <weHtmlEntity.h>

Inheritance diagram for WeHtmlDocument:

List of all members.

Public Member Functions
	WeHtmlDocument (iweEntity *prnt=NULL)
	Default constructor.
	WeHtmlDocument (WeHtmlDocument &entity)
	Copy constructor.
	~WeHtmlDocument ()
	Destructor.
virtual const string &	InnerText (void)
	Inner text.
virtual const string &	OuterText (void)
	Outer text.
virtual WeCmpResults *	Diff (iweEntity &cmp, weCmpMode mode)
virtual weCmpState	Compare (iweEntity &cmp, weCmpMode mode)
	Query if 'entity' is equal.
virtual WeBlob &	Data (void)
	Access the Data.
virtual bool	ParseData (iweResponse *resp, iweTransport *processor=NULL)
	Parse data stored inside WeHttpResponce.

---

Detailed Description

Web document. Entry point to parsed document.

Special kind of WeHtmlEntity - whole web document. It may contains some other WeHtmlEntity, such as page layout elements, or (and) other WeHtmlDocument's. For example, if the root document contains frames, the frames sources will be added to root document as the child documents.

Author:

A. Abramov

Date:

26.05.2009

Examples:

httpget.cpp.

Definition at line 149 of file weHtmlEntity.h.

---

Constructor & Destructor Documentation

WeHtmlDocument::WeHtmlDocument

(

iweEntity *

prnt = NULL

)

Default constructor.

Definition at line 655 of file weHtmlEntity.cpp.

WeHtmlDocument::WeHtmlDocument

(

WeHtmlDocument &

entity

)

Copy constructor.

Parameters:

entity

- the document to make copy of.

Definition at line 671 of file weHtmlEntity.cpp.

WeHtmlDocument::~WeHtmlDocument

(

void

)

Destructor.

Definition at line 683 of file weHtmlEntity.cpp.

---

Member Function Documentation

weCmpState WeHtmlDocument::Compare	(	iweEntity &	entity,
		weCmpMode	mode
	)			[virtual]

Query if 'entity' is equal.

Parameters:

	entity	- the entity for comparison.
	mode	- the mode comparison mode.

Return values:

true

if equal, false if not.

Todo:

Implement this!

Reimplemented from WeHtmlEntity.

Definition at line 769 of file weHtmlEntity.cpp.

WeBlob & WeHtmlDocument::Data

(

void

)

[virtual]

Access the Data.

Grants access to the linked response data.

Data property represents downloaded data of the linked object. Images, script sources and other data may be stored here.

Exceptions:

WeError

if no iweResponse assigned

Implements iweDocument.

Examples:

httpget.cpp.

Definition at line 755 of file weHtmlEntity.cpp.

WeCmpResults * WeHtmlDocument::Diff	(	iweEntity &	cmp,
		weCmpMode	mode
	)			[virtual]

Todo:

Implement this!

Reimplemented from WeHtmlEntity.

Definition at line 763 of file weHtmlEntity.cpp.

const string & WeHtmlDocument::InnerText

(

void

)

[virtual]

Inner text.

Return values:

null

if something wrong, inner text string otherwise.

Reimplemented from WeHtmlEntity.

Definition at line 694 of file weHtmlEntity.cpp.

const string & WeHtmlDocument::OuterText

(

void

)

[virtual]

Outer text.

Return values:

null

if something wrong, string that represents the HTML-encoded entity, includes own tags and all child entities otherwise.

Reimplemented from WeHtmlEntity.

Definition at line 708 of file weHtmlEntity.cpp.

bool WeHtmlDocument::ParseData	(	iweResponse *	resp,
		iweTransport *	processor = NULL
	)			[virtual]

Parse data stored inside WeHttpResponce.

Parameters:

	processor	- iweTransport object with processing options and network connection
	resp	- iweResponse object with received data to parse

Return values:

true

if it succeeds, false if it fails.

Implements iweDocument.

Examples:

httpget.cpp.

Definition at line 730 of file weHtmlEntity.cpp.

---

The documentation for this class was generated from the following files:

• weHtmlEntity.h
• weHtmlEntity.cpp